Outgoing webhook
An OutgoingWebhook represents the configuration for an external endpoint that automation events are sent to. "Outgoing" refers to events leaving the Portant platform for an external destination.
For details on the events Portant sends, see Listen to events from Portant via webhooks.
Fields
| Field | Type | Description |
|---|---|---|
| id | String | The ID of the outgoing webhook configuration. |
| webhookUrl | String | The webhook address that events will be POSTed to. |
Example
{
"id": "owc_XY1Ys4gqrpX8cp",
"webhookUrl": "https://webhook.site/d22c56ab-40ac-4f9a-93ef-02520235c0da"
},
Endpoints
Get an outgoing webhook
GET /workflows/<wkf_id>/outgoing-webhooks/
Retrieve the outgoing webhook configuration for a specific workflow.
Responses
| Status | Body |
|---|---|
| 200 OK | OutgoingWebhook |
| 403 Unauthorised | Error |
Create an outgoing webhook
POST /workflows/<wkf_id>/outgoing-webhooks/
Create the outgoing webhook configuration for a specific workflow.
Request
The body must contain a single webhookUrl field with the URL you want to receive events at.
{
webhookUrl: "https://..."
}
Responses
| Status | Body |
|---|---|
| 201 Created | OutgoingWebhook |
| 400 Bad Request | Error |
| 403 Unauthorised | Error |
Update an outgoing webhook
PATCH /workflows/<wkf_id>/outgoing-webhooks/
Update the outgoing webhook configuration for a specific workflow.
Request
The body must contain a single webhookUrl field with the URL you want to receive events at.
{
webhookUrl: "https://..."
}
Responses
| Status | Body |
|---|---|
| 200 OK | OutgoingWebhook |
| 400 Bad Request | Error |
| 403 Unauthorised | Error |