Webhooks API

Webhook endpoints tell Custom Domain Kit where to deliver domain status events.

List Webhook Endpoints

GET /v1/applications/:applicationId/webhooks

Create Webhook Endpoint

POST /v1/applications/:applicationId/webhooks
Content-Type: application/json

{
  "url": "https://app.example.com/webhooks/custom-domain-kit"
}

The response includes a webhook signing secret once:

{
  "webhookEndpoint": {
    "id": "wh_123",
    "url": "https://app.example.com/webhooks/custom-domain-kit",
    "enabled": true
  },
  "secret": "whsec_..."
}

Get Webhook Endpoint

GET /v1/applications/:applicationId/webhooks/:webhookEndpointId

Update Webhook Endpoint

PATCH /v1/applications/:applicationId/webhooks/:webhookEndpointId
Content-Type: application/json

{
  "url": "https://app.example.com/webhooks/custom-domain-kit",
  "enabled": true
}

Rotate Webhook Secret

POST /v1/applications/:applicationId/webhooks/:webhookEndpointId/secret

Update your receiver before or immediately after rotation.

Delete Webhook Endpoint

DELETE /v1/applications/:applicationId/webhooks/:webhookEndpointId

Returns 204 No Content.