Webhooks

Endpoints, the event catalogue, test deliveries, secret rotation, delivery history and retries.

10 routes

At most ten endpoints per application. The signing secret is returned once, on creation, and again only by rotation.

The guide for this family is Webhooks.

GET /v1/developer/applications/{applicationId}/webhooks

GET /v1/developer/applications/{applicationId}/webhooks

Authentication: Developer console session

POST /v1/developer/applications/{applicationId}/webhooks

POST /v1/developer/applications/{applicationId}/webhooks

Authentication: Developer console session

Request body — CreateWebhookEndpointDto

urlrequired: string — IsString, MaxLength(2048)
descriptionoptional: string — IsString, MaxLength(300)
eventsrequired: string[] — IsArray, IsString({ each: true })

DELETE /v1/developer/applications/{applicationId}/webhooks/{endpointId}

DELETE /v1/developer/applications/{applicationId}/webhooks/{endpointId}

Authentication: Developer console session

GET /v1/developer/applications/{applicationId}/webhooks/{endpointId}

GET /v1/developer/applications/{applicationId}/webhooks/{endpointId}

Authentication: Developer console session

PATCH /v1/developer/applications/{applicationId}/webhooks/{endpointId}

PATCH /v1/developer/applications/{applicationId}/webhooks/{endpointId}

Authentication: Developer console session

Request body — UpdateWebhookEndpointDto

urloptional: string — IsString, MaxLength(2048)
descriptionoptional: string — IsString, MaxLength(300)
eventsoptional: string[] — IsArray, IsString({ each: true })
statusoptional: string — IsIn(['active', 'disabled'])
configurationVersionoptional: number — IsInt, Min(1)

POST /v1/developer/applications/{applicationId}/webhooks/{endpointId}/rotate-secret

POST /v1/developer/applications/{applicationId}/webhooks/{endpointId}/rotate-secret

Authentication: Developer console session

POST /v1/developer/applications/{applicationId}/webhooks/{endpointId}/test

POST /v1/developer/applications/{applicationId}/webhooks/{endpointId}/test

Authentication: Developer console session

POST /v1/developer/applications/{applicationId}/webhooks/deliveries/{deliveryId}/retry

POST /v1/developer/applications/{applicationId}/webhooks/deliveries/{deliveryId}/retry

Authentication: Developer console session

GET /v1/developer/applications/{applicationId}/webhooks/deliveries/history

GET /v1/developer/applications/{applicationId}/webhooks/deliveries/history

Authentication: Developer console session

GET /v1/developer/applications/{applicationId}/webhooks/events

GET /v1/developer/applications/{applicationId}/webhooks/events

Authentication: Developer console session

What this does not do

Responses are not listed. The API declares no response types, so this page describes what to send and who may send it. Recorded response shapes are on the guides.
This page is generated. It was read from the API at commit 234dba22. Editing it by hand changes nothing; the next sync overwrites it.

Verified against API commit 234dba22 on 2026-10-18. The routes, scopes, checklist, events and limits on these pages are read from that export, not typed.