Sends a test event to the webhook URL and reports the delivery status and remote response.
/api/webhooks/{id}/testSends a test event to the webhook URL and reports the delivery status and remote response. event defaults to conversation.created; payload defaults to an empty object.
Bearer API key or X-API-Key header.webhooks:writeautomation_api)Path parameter. Unique identifier of this resource.
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Request body accepted by this operation.
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
{
"success": true,
"statusCode": 204,
"latency": 142,
"response": ""
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Authentication is required.",
"correlationId": "req_01K0MANAGEMENT401"
}
}{
"error": {
"code": "INTEGRATION_MODULE_REQUIRED",
"message": "The automation API module is required.",
"details": {
"module": "automation_api",
"feature": "public_api"
},
"correlationId": "req_01K0MANAGEMENT402"
}
}{
"error": {
"code": "FORBIDDEN",
"message": "The caller lacks the required role or API-key scope.",
"correlationId": "req_01K0MANAGEMENT403"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "The requested resource was not found.",
"correlationId": "req_01K0MANAGEMENT404"
}
}{
"error": {
"code": "CONFLICT",
"message": "The requested change conflicts with current resource state.",
"correlationId": "req_01K0MANAGEMENT409"
}
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "The request payload is invalid.",
"details": {
"field": "name"
},
"correlationId": "req_01K0MANAGEMENT422"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "Too many requests.",
"correlationId": "req_01K0MANAGEMENT429"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}curl --request POST \
'https://api.convor.io/api/webhooks/11111111-1111-4111-8111-111111111111/test' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer convor_sk_...' \
--header 'Content-Type: application/json' \
--data '{
"event": "conversation.created",
"payload": {
"id": "test-123",
"visitorId": "visitor-456"
}
}'const response = await fetch("https://api.convor.io/api/webhooks/11111111-1111-4111-8111-111111111111/test", {
method: "POST",
headers: {
"Accept": "application/json",
"Authorization": "Bearer convor_sk_...",
"Content-Type": "application/json"
},
body: JSON.stringify({
"event": "conversation.created",
"payload": {
"id": "test-123",
"visitorId": "visitor-456"
}
}),
});
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?
Event. Allowed values: conversation.created, conversation.assigned, conversation.unassigned, conversation.resolved, conversation.reopened, conversation.snoozed, conversation.unsnoozed, conversation.merged, conversation.tag_added, conversation.tag_removed, conversation.pinned, conversation.unpinned, conversation.linked, conversation.unlinked, message.created, message.updated, message.deleted, visitor.captured, visitor.blocked, visitor.banned, visitor.unbanned, visitor.tag_added, survey.submitted, survey.response, csat.submitted, sla.breach.
Payload fields.