Auf Ereignisse von Portant über Webhooks lauschen

Lassen Sie Portant Ereignisse per POST an Ihren eigenen Server senden, wenn eine Automatisierung ausgeführt wird. Fügen Sie den Block Send Webhook Events (Webhook-Ereignisse senden) zu Ihrem Workflow hinzu, und Portant sendet für jedes verarbeitete Quellelement eine Anfrage.

Ereignisse werden pro Quellelement gesendet. Ein Quellelement ist eine einzelne Einheit von Quelldaten (zum Beispiel eine Zeile in Google Sheets). Wenn eine Automatisierung über mehrere Quellelemente läuft, sendet Portant einen Webhook pro Element.

Payload-Schema

Jedes von Portant gesendete Ereignis hat dieselbe übergeordnete Struktur. Der Inhalt von data ändert sich je nach event_type.

Feld	Beschreibung
event_id	Eine eindeutige ID, die für dieses Ereignis generiert wurde.
event_type	Der Typ des Ereignisses. Bestimmt, was in data enthalten ist (siehe die Ereignistypen unten).
data	Die Ereignis-Payload. Das Schema variiert je nach event_type.

Schema-Beispiel

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

Ereignistypen

Portant sendet derzeit vier Ereignistypen. Welche Sie empfangen, hängt von Ihrem Workflow ab: Sie erhalten zum Beispiel EMAILS_CREATED nur, wenn Ihr Workflow einen E-Mail-Block enthält.

Dokumente erstellt

Die Automatisierung hat neue Dokumente erstellt (Google Docs, Google Slides oder PDFs).

Workflow-Konfiguration

Der Workflow muss einen Template-Block (Google Docs oder Google Slides) enthalten.

Schema

Feld	Beschreibung
documents	Ein Array aller für dieses Quellelement erstellten Dokumente.
documents.id	Die Google Drive-ID der Datei.
documents.url	Die Google Drive-URL der Datei.
documents.name	Der Dateiname, wie er in Google Drive angezeigt wird.
documents.mimetype	Der MIME-Typ der Datei (siehe unten).

MIME-Typen

Mimetype	Beschreibung
application/vnd.google-apps.document	Google Docs-Datei
application/vnd.google-apps.presentation	Google Slides-Datei
application/pdf	PDF-Dokument

Beispiel-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 erstellt

Die Automatisierung hat E-Mails erstellt und gesendet. Dieses Ereignis wird nicht für Signaturanfragen ausgelöst.

Workflow-Konfiguration

Der Workflow muss einen E-Mail-Block (Gmail) enthalten.

Schema

Feld	Beschreibung
emails	Ein Array aller für dieses Quellelement erstellten E-Mails.
emails.message_id	Die Gmail-Nachrichten-ID.
emails.to	Eine kommagetrennte Zeichenkette mit Empfängeradressen.
emails.subject	Die Betreffzeile der E-Mail.

Beispiel-Payload

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

Signaturen angefordert

Die Automatisierung hat Signaturanfragen gesendet.

Workflow-Konfiguration

Der Workflow muss einen Signaturanfrage-Block enthalten.

Schema

Feld	Beschreibung
documents	Ein Array von Dokumenten, die für dieses Quellelement erstellt wurden. Gleiche Struktur wie das Documents created-Ereignis.
recipients	Ein Array von Empfängern einer Signaturanforderung im Workflow.
recipients.email	Die E-Mail-Adresse des Empfängers.
recipients.order	Die Reihenfolge, in der dieser Empfänger unterzeichnet.
recipients.status	Der aktuelle Status. Für dieses Ereignis immer "PENDING".
recipients.signature_url	Die URL zum Signaturportal, über das der Empfänger die Anforderung abschließen kann.

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

Signaturen abgeschlossen

Alle Signaturanforderungen in der Automatisierung wurden abgeschlossen.

Workflow-Konfiguration

Der Workflow muss einen Signaturanforderungsblock enthalten.

Schema

Entspricht dem Signatures requested-Ereignis. Das Feld recipients.status hat für jeden Empfänger den Wert "COMPLETED".

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