Deployments.ai Docs
Runtime

Send a signed test event to a webhook subscription

POST /v1/webhooks/{webhookId}/test · SDK testWebhook · CLI deployments webhook test

POST
/v1/webhooks/{webhookId}/test

Requires webhooks:write.

Authorization

headerAuthorizationBearer <token>

Opaque bearer credential scoped to one service account and tenant.

Path Parameters

webhookId*string
Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Header Parameters

x-deployments-environment?string

Required with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
x-deployments-organization?string

Required with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
x-deployments-project?string

Required with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Response Body

TestWebhookResponse

application/json
  1. response
delivered*boolean
durationMs*number|||
error?string
eventId*string
Match^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$
responseStatus?number|||
curl -X POST "https://example.com/v1/webhooks/string/test"
{  "delivered": true,  "durationMs": 0,  "error": "string",  "eventId": "string",  "responseStatus": 0}