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.
/api/webhooksReturns organization-scoped outbound webhooks with server-side URL search, event and site-binding filters, deterministic sort, and paginated results.
Endpoint requirements
- Credentials
- Use either
Bearer API keyorX-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.
Query Parameters
Query parameter. Sort by. Allowed values: url, events, sites, createdAt.
"createdAt"Value in
- "url"
- "events"
- "sites"
- "createdAt"
Query parameter. Sort direction. Allowed values: asc, desc.
"desc"Value in
- "asc"
- "desc"
Query parameter. Search text.
length <= 200Query parameter. Site access. Allowed values: all, allSites, selected.
"all"Value in
- "all"
- "allSites"
- "selected"
Query parameter. Value of event.
length <= 100Query parameter. One-based page number.
1 <= value <= 90071992547409911Query parameter. Maximum number of records to return.
1 <= value <= 10020Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
{ "data": [ { "id": "11111111-1111-4111-8111-111111111111", "url": "https://hooks.customer.example.org/convor", "events": [ "conversation.created", "message.created" ], "projectScope": "all", "projectIds": [], "createdAt": "2026-06-23T10:20:00.000Z" } ], "pagination": { "totalItems": 1, "page": 1, "pageSize": 1, "hasNextPage": false, "hasPrevPage": false }}Request examples
curl
curl --request GET \
'https://api.convor.io/api/webhooks' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer convor_sk_...'JavaScript
const response = await fetch("https://api.convor.io/api/webhooks", {
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 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.
Register a new webhook
Registers an HTTPS URL at a public IP to receive event notifications.