Ascoltare gli eventi da Portant tramite webhook

Consenti a Portant di inviare eventi POST al tuo server quando viene eseguita un'automazione. Aggiungi il blocco Send Webhook Events al tuo workflow e Portant invierà una richiesta per ogni elemento sorgente elaborato.

Gli eventi vengono inviati per elemento sorgente. Un elemento sorgente è una singola unità di dati sorgente (ad esempio, una riga in Google Sheets). Se un'automazione viene eseguita su più elementi sorgente, Portant invia un webhook per ogni elemento.

Schema del payload

Ogni evento inviato da Portant condivide la stessa struttura di primo livello. Il contenuto di data varia in base a event_type.

Campo	Descrizione
event_id	Un ID univoco generato per questo evento.
event_type	Il tipo di evento. Determina il contenuto di data (vedere i tipi di evento di seguito).
data	Il payload dell'evento. Lo schema varia in base a event_type.

Esempio di schema

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

Tipi di eventi

Portant invia attualmente quattro tipi di eventi. Quali vengono ricevuti dipende dal tuo workflow: ad esempio, ricevi EMAILS_CREATED solo se il tuo workflow include un blocco email.

Documenti creati

L'automazione ha creato nuovi documenti (Google Docs, Google Slides o PDF).

Configurazione del workflow

Il workflow deve contenere un blocco template (Google Docs o Google Slides).

Schema

Campo	Descrizione
documents	Un array di tutti i documenti creati per questo elemento sorgente.
documents.id	L'ID Google Drive del file.
documents.url	L'URL Google Drive del file.
documents.name	Il nome del file come appare in Google Drive.
documents.mimetype	Il tipo MIME del file (vedere di seguito).

Tipi MIME

Mimetype	Descrizione
application/vnd.google-apps.document	File Google Docs
application/vnd.google-apps.presentation	File Google Slides
application/pdf	Documento PDF

Esempio di 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"
}

Email create

L'automazione ha creato e inviato email. Questo evento non viene attivato per le richieste di firma.

Configurazione del workflow

Il workflow deve contenere un blocco email (Gmail).

Schema

Campo	Descrizione
emails	Un array di tutte le email create per questo elemento sorgente.
emails.message_id	L'ID messaggio Gmail.
emails.to	Una stringa di indirizzi dei destinatari separati da virgola.
emails.subject	L'oggetto dell'email.

Esempio di payload

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

Firme richieste

L'automazione ha inviato richieste di firma.

Configurazione del workflow

Il workflow deve contenere un blocco di richiesta di firma.

Schema

Campo	Descrizione
documents	Un array di documenti creati per questo elemento sorgente. Stessa struttura dell'evento Documents created.
recipients	Un array di destinatari della richiesta di firma nel workflow.
recipients.email	L'indirizzo email del destinatario.
recipients.order	L'ordine in cui il destinatario firma.
recipients.status	Lo stato corrente. Sempre "PENDING" per questo evento.
recipients.signature_url	L'URL al portale di firma in cui il destinatario può completare la richiesta.

Payload di esempio

{
  "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

Tutte le richieste di firma nell'automazione sono state completate.

Configurazione del workflow

Il workflow deve contenere un blocco di richiesta di firma.

Schema

Uguale all'evento Signatures requested. Il campo recipients.status è "COMPLETED" per ogni destinatario.

Payload di esempio

{
  "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"
}