v1

latestOpenAPI 3.1.02026-07-26359254.7 MB

Webhooks

List webhook subscriptions

<small>Requires the webhooks:read scope (or a broader one that includes it).</small>

Returns a paginated list of the authenticated user's webhook subscriptions, ordered by descending id. Use top/skip to page through results and inspect hasMore to detect additional pages.

get/v3/webhooks

Query parameters

topinteger

Maximum number of items to return (defaults to the API page size).

skipinteger

Number of items to skip.

Response

Paginated list of webhook subscriptions.

hasMoreboolean

Whether more items are available beyond the current page.

Example response

{
  "items": [
    {
      "id": 1823,
      "eventType": "email_replied",
      "url": "https://example.com/hooks/reply",
      "scope": "personal",
      "enabled": true,
      "createdAt": "2026-04-17T12:00:00+00:00",
      "payloadConfig": {
        "includeEmailUrl": true,
        "includeEmailText": false,
        "includeProspectCustomFields": true
      }
    }
  ]
}