Webhooks
Create a webhook
Creates a new webhook definition and returns the persisted record with its server-assigned id. The webhook fires immediately for matching events once created; set enabled=false in the request body to create it in a disabled state.
post/v6/webhooks
Request
- Base URLhttps://api.extole.io
- Auth
- API key in header Authorization
- or API key in query parameter access_token
- or API key in cookie extole_token
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Request body
Example request
{
"client_key_id": "handlebars@buildtime:{{clientKeyId}}",
"default_method": "handlebars@buildtime:{{defaultMethod}}",
"description": "handlebars@buildtime:{{description}}",
"enabled": "handlebars@buildtime:{{enabled}}",
"name": "handlebars@buildtime:{{name}}",
"request": "handlebars@buildtime:{{request}}",
"response_body_handler": "handlebars@buildtime:{{responseBodyHandler}}",
"response_handler": "handlebars@buildtime:{{responseHandler}}",
"retry_intervals": [
"PT42S"
],
"url": "handlebars@buildtime:{{url}}"
}Response
Successful response
Example response
{
"client_key_id": "handlebars@buildtime:{{clientKeyId}}",
"created_at": "2025-10-24T02:00:00-07:00",
"default_method": "handlebars@buildtime:{{defaultMethod}}",
"description": "handlebars@buildtime:{{description}}",
"enabled": "handlebars@buildtime:{{enabled}}",
"name": "handlebars@buildtime:{{name}}",
"request": "handlebars@buildtime:{{request}}",
"response_handler": "handlebars@buildtime:{{responseHandler}}",
"retry_intervals": [
"PT42S"
],
"updated_at": "2025-10-24T02:00:00-07:00",
"url": "handlebars@buildtime:{{url}}"
}Changes
No recorded changes to this operation across all 1 revision of this API.