Outgoing webhooks service overview

Find out more about outbound webhooks in our documentation.

Authentication and permissions

To use the Outgoing webhooks service API you need to create a personal or team API key. It’s recommended to use permission presets, as they are automatically updated with all relevant permissions. Alternatively, you can manually add the following individual permissions.

PresetsPermissionDescription
OutboundWebhooksoutbound-webhooks:ReadConfigGrants access to read outbound-webhooks
outbound-webhooks:ReadSummaryGrants access to read outbound-webhooks
outbound-webhooks:UpdateConfigRequired to create, update, or delete outbound-webhooks

Common error response codes

Status CodeDescription
400 Bad RequestResponse code 400
401 UnauthorizedResponse code 401
500 Internal Server ErrorResponse code 500

Constants