webhooks test - Clay docs

Send a signed test event to a webhook and report the delivery outcome. Use this to confirm your endpoint accepts and verifies Clay deliveries before you wire it to a routine run. For test events, the delivery payload’s data is {}. See the webhooks overview for the delivery payload shape and signature verification.

clay webhooks test <webhookId>

Arguments

Argument	Description
`webhookId`	Webhook id, e.g. the `id` returned by `clay webhooks list`. Required.

Output

{
  "id": "wh_abc123",
  "status": "success",
  "statusCode": 200
}

Field	Type	Description
`id`	string	Webhook id the test event was sent to.
`status`	`"success" \| "failed"`	`success` if the endpoint accepted the delivery (2xx); `failed` if it rejected the delivery or was unreachable.
`statusCode`	number	HTTP status code the endpoint returned. Omitted when the endpoint was unreachable.

Errors

Code	Exit	Notes
`auth_forbidden`	3	The API key lacks permission to manage webhooks.
`not_found`	6	No webhook with that id.

Examples

clay webhooks test wh_abc123
clay webhooks test wh_abc123 | jq -r '.status'

​Arguments

​Output

​Errors

​Examples

Arguments

Output

Errors

Examples