Sign in

v1

latestOpenAPI 3.0.02026-07-142351,1971.3 MB
Webhooks Integration

Create a webhooks integration

Creates an endpoint with the name <WEBHOOK_NAME>.

post/api/v1/integration/webhooks/configuration/webhooks

Request body

custom_headersstring nullable

If null, uses no header. If given a JSON payload, these will be headers attached to your webhook.

encode_as'json' | 'form'

Encoding type. Can be given either json or form.

namestring required

The name of the webhook. It corresponds with <WEBHOOK_NAME>. Learn more on how to use it in monitor notifications.

payloadstring nullable

If null, uses the default payload. If given a JSON payload, the webhook returns the payload specified by the given payload. Webhooks variable usage.

urlstring required

URL of the webhook.

Example request

{
  "name": "WEBHOOK_NAME",
  "url": "https://example.com/webhook"
}

Response

OK

custom_headersstring nullable

If null, uses no header. If given a JSON payload, these will be headers attached to your webhook.

encode_as'json' | 'form'

Encoding type. Can be given either json or form.

namestring required

The name of the webhook. It corresponds with <WEBHOOK_NAME>. Learn more on how to use it in monitor notifications.

payloadstring nullable

If null, uses the default payload. If given a JSON payload, the webhook returns the payload specified by the given payload. Webhooks variable usage.

urlstring required

URL of the webhook.

Example response

{
  "name": "WEBHOOK_NAME",
  "url": "https://example.com/webhook"
}