Skip to content
Convor
Convor Docs
API ReferenceWebhooks

List webhook events you can subscribe to

Returns the event names you can subscribe to when creating or updating an outbound webhook, with a short description and the editable data fields used to construct canonical test deliveries.

GET/api/webhooks/events

Returns the event names you can subscribe to when creating or updating an outbound webhook, with a short description and the editable data fields used to construct canonical test deliveries. The delivery envelope always adds event, projectId, and timestamp.

Endpoint requirements

Credentials
Use either Bearer API key or X-API-Key header.
Required scope
webhooks:read
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
Safe read: You can safely retry this read-only request after a transport failure. It does not change resource state.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

{  "events": [    {      "event": "conversation.created",      "description": "A new conversation was started.",      "testFields": [        {          "key": "id",          "type": "string",          "defaultValue": "44444444-4444-4444-8444-444444444444",          "required": true,          "format": "uuid"        },        {          "key": "visitorId",          "type": "string",          "defaultValue": "33333333-3333-4333-8333-333333333333",          "required": true,          "format": "uuid"        },        {          "key": "channel",          "type": "string",          "defaultValue": "web",          "required": false        },        {          "key": "isOffline",          "type": "boolean",          "defaultValue": false,          "required": true        }      ]    },    {      "event": "message.created",      "description": "A new message was sent or received.",      "testFields": [        {          "key": "id",          "type": "string",          "defaultValue": "11111111-1111-4111-8111-111111111111",          "required": true,          "format": "uuid"        },        {          "key": "conversationId",          "type": "string",          "defaultValue": "44444444-4444-4444-8444-444444444444",          "required": true,          "format": "uuid"        },        {          "key": "senderType",          "type": "string",          "defaultValue": "visitor",          "required": true,          "options": [            "visitor",            "operator",            "system",            "ai"          ]        },        {          "key": "type",          "type": "string",          "defaultValue": "text",          "required": true,          "options": [            "text",            "file",            "image",            "system",            "internal_note"          ]        },        {          "key": "forwardedFrom",          "type": "string",          "defaultValue": "66666666-6666-4666-8666-666666666666",          "required": false,          "format": "uuid"        }      ]    }  ]}

Request examples

curl

curl --request GET \
  'https://api.convor.io/api/webhooks/events' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer convor_sk_...'

JavaScript

const response = await fetch("https://api.convor.io/api/webhooks/events", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer convor_sk_..."
  },
});

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?

List webhook delivery history

Returns recent delivery attempts for one webhook, ordered from newest to oldest.

List webhooks for the current organization

Returns organization-scoped outbound webhooks with server-side URL search, event and site-binding filters, deterministic sort, and paginated results.

On this page

Request examplescurlJavaScript