Sign in

v1

latestOpenAPI 3.0.12026-07-226992320.0 KB
Webhooks

List Webhooks

Returns a paginated list of webhooks for the account, sorted by most recently created first. Use agentId to filter by agent and active to filter by enabled/disabled status. Use page and size to navigate through results.

get/v1/webhooks

Query parameters

agentIdstring

Filter webhooks by the agent they are scoped to. Obtained from the agentId field in the agent list or creation response. Omit to return webhooks across all agents.

activeboolean

Filter webhooks by their active status. true returns only webhooks currently enabled and receiving event deliveries. false returns only disabled webhooks. Defaults to true.

pageinteger

Zero-based page number to retrieve. Use 0 for the first page. Must be 0 or greater.

sizeinteger

Number of webhooks to return per page. Must be 1 or greater. Defaults to 10.

Response

OK

pageinteger

Current page number (0-based index). Indicates which page of results is being returned.

sizeinteger

Number of items requested per page. Determines the maximum size of the 'data' list.

totalCountinteger

Total number of records available across all pages. Useful for calculating pagination on the client side.

totalPagesinteger

Total number of pages available based on totalCounts and size. Helps clients understand how many pages exist in total.

hasNextboolean

Indicates whether there is a next page available after the current one. Useful for implementing 'Load More' or next navigation.

hasPreviousboolean

Indicates whether there is a previous page before the current one. Useful for enabling backward navigation.

Example response

{
  "data": [
    {
      "workspaceId": "org_BUbkx3PsbzQm5V10",
      "webhookId": "wh_BUbkx3PsbzQm5V10",
      "name": "Call Events - Production",
      "agentId": "D5D0p7TUs66TTAEAx",
      "active": true,
      "secret": "mK9vXq2pL8nR5tY1wA3sD6fH0jC4bE7u"
    }
  ],
  "size": 20,
  "totalCount": 125,
  "totalPages": 7,
  "hasNext": true
}