Outgoing webhook
Een OutgoingWebhook vertegenwoordigt de configuratie voor een extern eindpunt waarnaar automatiseringsgebeurtenissen worden verzonden. "Outgoing" verwijst naar gebeurtenissen die het Portant-platform verlaten richting een externe bestemming.
Raadpleeg voor meer informatie over de gebeurtenissen die Portant verstuurt Listen to events from Portant via webhooks.
Fields (Velden)
| Field | Type | Description |
|---|---|---|
| id | String | Het ID van de outgoing webhook-configuratie. |
| webhookUrl | String | Het webhook-adres waarnaar gebeurtenissen via POST worden verstuurd. |
Example (Voorbeeld)
{
"id": "owc_XY1Ys4gqrpX8cp",
"webhookUrl": "https://webhook.site/d22c56ab-40ac-4f9a-93ef-02520235c0da"
},
Endpoints
Get an outgoing webhook (Een outgoing webhook ophalen)
GET /workflows/<wkf_id>/outgoing-webhooks/
Haal de outgoing webhook-configuratie op voor een specifieke workflow.
Responses (Antwoorden)
| Status | Body |
|---|---|
| 200 OK | OutgoingWebhook |
| 403 Unauthorised | Error |
Create an outgoing webhook (Een outgoing webhook aanmaken)
POST /workflows/<wkf_id>/outgoing-webhooks/
Maak de outgoing webhook-configuratie aan voor een specifieke workflow.
Request (Verzoek)
De body moet één enkel webhookUrl-veld bevatten met de URL waarop u gebeurtenissen wilt ontvangen.
{
webhookUrl: "https://..."
}
Responses (Antwoorden)
| Status | Body |
|---|---|
| 201 Created | OutgoingWebhook |
| 400 Bad Request | Error |
| 403 Unauthorised | Error |
Update an outgoing webhook (Een outgoing webhook bijwerken)
PATCH /workflows/<wkf_id>/outgoing-webhooks/
Werk de outgoing webhook-configuratie bij voor een specifieke workflow.
Request (Verzoek)
De body moet één enkel webhookUrl-veld bevatten met de URL waarop u gebeurtenissen wilt ontvangen.
{
webhookUrl: "https://..."
}
Responses (Antwoorden)
| Status | Body |
|---|---|
| 200 OK | OutgoingWebhook |
| 400 Bad Request | Error |
| 403 Unauthorised | Error |