Outgoing Webhook
Overview
The OutgoingWebhook resources represents the configuration of an external configuration that events from automation events will be sent to. The term "Outgoing" is often used for this type of webhook to indicate that events are outgoing from the Portant platform to an external destination.
For more details on how to listen to webhook events from Portant please see the following article: Listen to Events from Portant via Webhooks
Fields
id
String
The ID of the outgoing webhook configuration.
webhookUrl
String
The webhook address that events will be POST'ed to.
Example
Endpoints
Get an OutgoingWebhook
Retrieve the outgoing webhook configuration of the specific workflow as specified by the id.
Responses
200 OK
OutgoingWebhook
403 Unauthorised
Error
Create an OutgoingWebhook
Create the outgoing webhook configuration of the specific workflow as specified by the id.
Request
The request body must contain a single field that is the webhook URL you wish to receive events at.
Responses
201 Created
OutgoingWebhook
400 Bad Request
Error
403 Unauthorised
Error
Update an OutgoingWebhook
Update the outgoing webhook configuration of the specific workflow as specified by the id.
Request
The request body must contain a single field that is the webhook URL you wish to receive events at.
Responses
200 OK
OutgoingWebhook
400 Bad Request
Error
403 Unauthorised
Error
Last updated