Register a new webhook
Registers an HTTPS URL at a public IP to receive event notifications.
/api/webhooksRegisters an HTTPS URL at a public IP to receive event notifications. Every delivery uses the versioned JSON envelope { event, projectId, timestamp, data } and is signed with HMAC-SHA256. projectId always identifies the site that emitted the event, including webhooks bound to multiple sites. If secret is omitted, the API generates a signing secret and returns it only in the create response. A client-supplied secret is not echoed. List and delivery-history responses never include signing secrets; secret rotation returns the new plaintext value once.
Endpoint requirements
- Credentials
- Use either
Bearer API keyorX-API-Key header. - Required scope
webhooks:write- Module
- Automation & API module (
api_access) - Organization and site scope
- Requests can access only resources owned by the authenticated organization. The API does not reveal whether an identifier belongs to another organization or site.
- Retry behavior
- Convergent write: Retrying leaves the resource in the same resulting state. If the first request succeeded, a later retry may return conflict or not found because the change has already taken effect.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Request body accepted by this operation.
Request body accepted by this operation.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
{ "id": "11111111-1111-4111-8111-111111111111", "url": "https://hooks.customer.example.org/convor", "events": [ "conversation.created", "message.created" ], "projectScope": "all", "projectIds": [ "11111111-1111-4111-8111-111111111111" ], "createdAt": "2026-08-03T18:00:00.000Z"}Request examples
curl
curl --request POST \
'https://api.convor.io/api/webhooks' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer convor_sk_...' \
--header 'Content-Type: application/json' \
--data '{
"projectScope": "all",
"projectIds": [],
"url": "https://hooks.customer.example.org/convor",
"events": [
"conversation.created",
"message.created"
],
"secret": "replace-with-your-signing-secret"
}'JavaScript
const response = await fetch("https://api.convor.io/api/webhooks", {
method: "POST",
headers: {
"Accept": "application/json",
"Authorization": "Bearer convor_sk_...",
"Content-Type": "application/json"
},
body: JSON.stringify({
"projectScope": "all",
"projectIds": [],
"url": "https://hooks.customer.example.org/convor",
"events": [
"conversation.created",
"message.created"
],
"secret": "replace-with-your-signing-secret"
}),
});
const contentType = response.headers.get("content-type") ?? "";
const data = response.status === 204
? null
: contentType.includes("json")
? await response.json()
: contentType.startsWith("text/")
? await response.text()
: await response.blob();
if (!response.ok) {
const message = typeof data === "object" && data !== null
&& "error" in data && typeof data.error === "object"
&& data.error !== null && "message" in data.error
? String(data.error.message)
: "Convor API request failed (" + response.status + ")";
throw new Error(message);
}
console.log(data);Was this page helpful?