Webhooks
Create a webhook endpoint
Register an HTTPS receiver and retrieve its signing secret once.
POST
Register an HTTPS receiver and retrieve its signing secret once.
Use a developer access key. See authentication, errors, and rate limits.
Required scopes:
This request changes workspace data. A timeout does not prove that the write failed; inspect the result before retrying.
webhooks:write.
Replace the example receiver with your own deployed HTTPS endpoint. Save secret in the receiver’s secret store; listing will not reveal it again. Verify webhook signatures before processing. A rejected target returns 400.
Parameters
string
required
Trimmed HTTPS URL, 1–2,048 characters. Must resolve to a public address; URL credentials and private targets are rejected.
string | null
Optional description, at most 200 trimmed characters.
string[]
required
Nonempty list of supported event names from GET /v1/webhooks/events.
Response
201 — Returns the resource underdata. Example IDs and values are illustrative.