Ausgehender Webhook

Ein OutgoingWebhook repräsentiert die Konfiguration für einen externen Endpunkt, an den Automatisierungsereignisse gesendet werden. „Ausgehend" bezieht sich auf Ereignisse, die die Portant-Plattform in Richtung eines externen Ziels verlassen.

Einzelheiten zu den Ereignissen, die Portant sendet, finden Sie unter Listen to events from Portant via webhooks.

Felder

Feld	Typ	Beschreibung
id	String	Die ID der ausgehenden Webhook-Konfiguration.
webhookUrl	String	Die Webhook-Adresse, an die Ereignisse per POST gesendet werden.

Beispiel

{
    "id": "owc_XY1Ys4gqrpX8cp",
    "webhookUrl": "https://webhook.site/d22c56ab-40ac-4f9a-93ef-02520235c0da"
},

Endpunkte

Ausgehenden Webhook abrufen

GET /workflows/<wkf_id>/outgoing-webhooks/

Rufen Sie die ausgehende Webhook-Konfiguration für einen bestimmten Workflow ab.

Antworten

Status	Body
200 OK	OutgoingWebhook
403 Unauthorised	Error

Ausgehenden Webhook erstellen

POST /workflows/<wkf_id>/outgoing-webhooks/

Erstellen Sie die ausgehende Webhook-Konfiguration für einen bestimmten Workflow.

Anfrage

Der Body muss ein einzelnes webhookUrl-Feld mit der URL enthalten, an der Sie Ereignisse empfangen möchten.

{
    webhookUrl: "https://..."
}

Antworten

Status	Body
201 Created	OutgoingWebhook
400 Bad Request	Error
403 Unauthorised	Error

Ausgehenden Webhook aktualisieren

PATCH /workflows/<wkf_id>/outgoing-webhooks/

Aktualisieren Sie die ausgehende Webhook-Konfiguration für einen bestimmten Workflow.

Anfrage

Der Body muss ein einzelnes webhookUrl-Feld mit der URL enthalten, an der Sie Ereignisse empfangen möchten.

{
    webhookUrl: "https://..."
}

Antworten

Status	Body
200 OK	OutgoingWebhook
400 Bad Request	Error
403 Unauthorised	Error