POST
/v1/webhooksCreate webhooks
Register an endpoint to be notified on. Needs a name of up to 80 characters, an https URL of up to 2000 with no spaces, and at least one event from the closed list; auth says which credential the RECEIVER wants, and leaving it out means none. This is one of exactly two answers that ever carries the signing secret in full — keep it now, it cannot be read back. 409 on a duplicate name, 503 when this service holds no key to seal the secret with. Admin only.
Access class: workspace:admin.
Send request
Use the documented inputs to call this endpoint directly.
API serverbase URL
Bearer tokensessionoptional
Stored only in this browser for the session security scheme and reused on every API page in this group.
Request body
application/jsonrequiredbodyoptional
paramsobjectoptional
queryobjectoptional
Responses
201application/json
the action's answer
{
"data": {
"secret": "string",
"webhook": {
"authHeaderName": "string",
"authKind": "string",
"createdAt": "string",
"createdBy": 1,
"description": "string",
"events": [
"string"
],
"id": "",
"name": "string",
"secretHint": "string",
"secretRotatedAt": "string",
"status": "string",
"updatedAt": "string",
"url": "string"
}
}
}dataoptional
defaultapplication/json
a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.
{
"error": "string"
}errorstringrequired