Escute eventos do Portant via webhooks

Faça o Portant enviar eventos via POST para o seu próprio servidor quando uma automação for executada. Adicione o bloco Send Webhook Events ao seu fluxo de trabalho e o Portant disparará uma requisição para cada item de origem processado.

Os eventos são enviados por item de origem. Um item de origem é uma unidade única de dados de origem (por exemplo, uma linha no Google Sheets). Se uma automação for executada sobre múltiplos itens de origem, o Portant envia um webhook por item.

Esquema do payload

Todos os eventos enviados pelo Portant compartilham o mesmo formato de nível superior. O conteúdo de data varia conforme o event_type.

Campo	Descrição
event_id	Um ID único gerado para este evento.
event_type	O tipo de evento. Determina o que está em data (consulte os tipos de evento abaixo).
data	O payload do evento. O esquema varia conforme o event_type.

Exemplo de esquema

{
  "data": {
    ... // Determined by the type of event
  },
  "event_id": "325d36e717d9ec0943a55857ae2d4988ce33fe4165330e4f",
  "event_type": "<EVENT_TYPE>"
}

Tipos de eventos

O Portant atualmente envia quatro tipos de evento. Quais deles você receberá depende do seu fluxo de trabalho: por exemplo, você só receberá EMAILS_CREATED se o seu fluxo de trabalho incluir um bloco de e-mail.

Documentos criados

A automação criou novos documentos (Google Docs, Google Slides ou PDFs).

Configuração do fluxo de trabalho

O fluxo de trabalho deve conter um bloco de template (Google Docs ou Google Slides).

Esquema

Campo	Descrição
documents	Um array com todos os documentos criados para este item de origem.
documents.id	O ID do Google Drive para o arquivo.
documents.url	A URL do Google Drive para o arquivo.
documents.name	O nome do arquivo conforme aparece no Google Drive.
documents.mimetype	O tipo MIME do arquivo (veja abaixo).

Tipos MIME

Mimetype	Descrição
application/vnd.google-apps.document	Arquivo Google Docs
application/vnd.google-apps.presentation	Arquivo Google Slides
application/pdf	Documento PDF

Exemplo de payload

{
  "data": {
    "documents": [
      {
        "id": "12XXXXX..................",
        "url": "https://docs.google.com/document/d/12XXXXX................../edit?usp=drivesdk",
        "name": "Invoice #1200",
        "mimetype": "application/vnd.google-apps.document"
      },
      {
        "id": "13XXXXX..................",
        "url": "https://drive.google.com/file/d/13XXXXX................../view?usp=drivesdk",
        "name": "Invoice #1200",
        "mimetype": "application/pdf"
      }
    ]
  },
  "event_id": "325d36e717d9ec0943a55857ae2d4988ce33fe4165330e4f",
  "event_type": "DOCUMENTS_CREATED"
}

E-mails criados

A automação criou e enviou e-mails. Este evento não é disparado para solicitações de assinatura.

Configuração do fluxo de trabalho

O fluxo de trabalho deve conter um bloco de e-mail (Gmail).

Esquema

Campo	Descrição
emails	Um array com todos os e-mails criados para este item de origem.
emails.message_id	O ID da mensagem no Gmail.
emails.to	Uma string com os endereços dos destinatários separados por vírgula.
emails.subject	A linha de assunto do e-mail.

Exemplo de payload

{
  "data": {
    "emails": [
      {
        "to": "contact@portant.co",
        "subject": "Hello World",
        "message_id": "18xxxx........."
      }
    ]
  },
  "event_id": "eac17961e3edcfafcc064015131e8a518c9f375005b8cec2",
  "event_type": "EMAILS_CREATED"
}

Assinaturas solicitadas

A automação enviou solicitações de assinatura.

Configuração do fluxo de trabalho

O fluxo de trabalho deve conter um bloco de solicitação de assinatura.

Esquema

Campo	Descrição
documents	Um array de documentos criados para este item de origem. Mesmo formato do evento Documents created.
recipients	Um array de destinatários da solicitação de assinatura no fluxo de trabalho.
recipients.email	O e-mail do destinatário.
recipients.order	A ordem em que este destinatário assina.
recipients.status	O status atual. Sempre "PENDING" para este evento.
recipients.signature_url	A URL do portal de assinaturas onde o destinatário pode concluir a solicitação.

Exemplo de payload

{
  "data": {
    "documents": [
      {
        "id": "10XXXXX.................",
        "url": "https://drive.google.com/file/d/10XXXXX................./view?usp=drivesdk",
        "name": "Employment Contact",
        "mimetype": "application/pdf"
      }
    ],
    "recipients": [
      {
        "email": "bwlockley@gmail.com",
        "order": 1,
        "status": "PENDING",
        "signature_url": "https://sign.portant.co/xxxxxxxxxxxxx"
      }
    ]
  },
  "event_id": "66de24a8c20fa439d47d92a683861f6852c2924632623377",
  "event_type": "SIGNATURES_REQUESTED"
}

Signatures completed

Todas as solicitações de assinatura na automação foram concluídas.

Configuração do fluxo de trabalho

O fluxo de trabalho deve conter um bloco de solicitação de assinatura.

Schema

Mesmo formato do evento Signatures requested. O campo recipients.status é "COMPLETED" para cada destinatário.

Exemplo de payload

{
  "data": {
    "documents": [
      {
        "id": "10XXXXX.................",
        "url": "https://drive.google.com/file/d/10XXXXX......../view?usp=drivesdk",
        "name": "Employment Contact",
        "mimetype": "application/pdf"
      }
    ],
    "recipients": [
      {
        "email": "bwlockley@gmail.com",
        "order": 1,
        "status": "COMPLETED",
        "signatureUrl": "https://sign.portant.co/xxxxxxxxxxxxx"
      }
    ]
  },
  "event_id": "72c32ca744baea46b4be710f052b14a9b73a29d77076e586",
  "event_type": "SIGNATURES_COMPLETED"
}