Luister naar gebeurtenissen van Portant via webhooks

Laat Portant POST-gebeurtenissen naar uw eigen server sturen wanneer een automatisering wordt uitgevoerd. Voeg het blok Send Webhook Events toe aan uw workflow en Portant stuurt een verzoek voor elk verwerkt bronitem.

Gebeurtenissen worden verzonden per bronitem. Een bronitem is een enkele eenheid brongegevens (bijvoorbeeld één rij in Google Sheets). Als een automatisering over meerdere bronitems wordt uitgevoerd, stuurt Portant één webhook per item.

Payload-schema

Elke gebeurtenis die Portant verstuurt, heeft dezelfde structuur op het hoogste niveau. De inhoud van data varieert op basis van event_type.

Field	Description
event_id	Een uniek ID dat voor deze gebeurtenis is gegenereerd.
event_type	Het type gebeurtenis. Bepaalt wat er in data staat (zie de gebeurtenistypen hieronder).
data	De payload van de gebeurtenis. Het schema varieert per event_type.

Schemavoorbeeld

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

Typen gebeurtenissen

Portant verstuurt momenteel vier gebeurtenistypen. Welke u ontvangt, is afhankelijk van uw workflow: u ontvangt bijvoorbeeld alleen EMAILS_CREATED als uw workflow een e-mailblok bevat.

Documenten aangemaakt

De automatisering heeft nieuwe documenten aangemaakt (Google Docs, Google Slides of PDF's).

Workflowconfiguratie

De workflow moet een sjabloonblok bevatten (Google Docs of Google Slides).

Schema

Field	Description
documents	Een array van alle documenten die voor dit bronitem zijn aangemaakt.
documents.id	Het Google Drive-ID van het bestand.
documents.url	De Google Drive-URL van het bestand.
documents.name	De bestandsnaam zoals deze wordt weergegeven in Google Drive.
documents.mimetype	Het MIME-type van het bestand (zie hieronder).

MIME-typen

Mimetype	Description
application/vnd.google-apps.document	Google Docs-bestand
application/vnd.google-apps.presentation	Google Slides-bestand
application/pdf	PDF-document

Voorbeeldpayload

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

De automatisering heeft e-mails aangemaakt en verzonden. Deze gebeurtenis wordt niet geactiveerd voor handtekeningverzoeken.

Workflowconfiguratie

De workflow moet een e-mailblok bevatten (Gmail).

Schema

Field	Description
emails	Een array van alle e-mails die voor dit bronitem zijn aangemaakt.
emails.message_id	Het Gmail-bericht-ID.
emails.to	Een door komma's gescheiden reeks ontvangeradressen.
emails.subject	De onderwerpregel van de e-mail.

Voorbeeldpayload

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

Handtekeningen aangevraagd

De automatisering heeft handtekeningverzoeken verstuurd.

Workflowconfiguratie

De workflow moet een blok voor handtekeningverzoeken bevatten.

Schema

Veld	Beschrijving
documents	Een array van documenten die voor dit bronitem zijn aangemaakt. Heeft dezelfde structuur als het Documents created-event.
recipients	Een array van ontvangers van het ondertekeningsverzoek in de workflow.
recipients.email	Het e-mailadres van de ontvanger.
recipients.order	De volgorde waarin deze ontvanger ondertekent.
recipients.status	De huidige status. Altijd "PENDING" voor dit event.
recipients.signature_url	De URL naar het ondertekeningsportaal waar de ontvanger het verzoek kan voltooien.

Voorbeeldpayload

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

Handtekeningen voltooid

Elk ondertekeningsverzoek in de automatisering is voltooid.

Workflowconfiguratie

De workflow moet een blok voor ondertekeningsverzoeken bevatten.

Schema

Hetzelfde als het Signatures requested-event. Het veld recipients.status is "COMPLETED" voor elke ontvanger.

Voorbeeldpayload

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