webhooks create - Clay docs

Create a webhook endpoint for the authenticated workspace. The response returns the signing secret exactly once — capture it now, because it can never be read again. Use the returned webhook id with clay routines runs start --webhook-id. See the webhooks overview for the delivery payload shape and signature verification.

clay webhooks create <url>

Arguments

Argument	Description
`url`	HTTPS endpoint that will receive signed webhook deliveries. Required.

Output

{
  "id": "wh_abc123",
  "url": "https://example.com/hooks/clay",
  "createdAt": "2026-06-16T17:50:00.000Z",
  "signingSecret": "whsec_..."
}

Field	Type	Description
`id`	string	Webhook id. Pass it to `--webhook-id`, `clay webhooks test`, or `clay webhooks delete`.
`url`	string	The endpoint that receives deliveries.
`createdAt`	string	Creation timestamp.
`signingSecret`	string	HMAC signing secret. Returned exactly once — store it now; it can never be read again.

Errors

Code	Exit	Notes
`validation_error`	2	`<url>` is not a valid URL.
`auth_forbidden`	3	The API key lacks permission to manage webhooks.
`not_found`	6	Webhooks are not enabled.

Examples

clay webhooks create https://example.com/hooks/clay
clay webhooks create https://example.com/hooks/clay | jq -r '.signingSecret'

​Arguments

​Output

​Errors

​Examples

Arguments

Output

Errors

Examples