Sign in

v1

latestOpenAPI 3.0.12026-07-22120163333.7 KB
Webhooks

List Webhooks

Returns all webhook subscriptions configured for the caller's team. See the Webhooks tag description for the full list of event types. For detailed payload shapes per event type, see Webhook Event Payloads.

get/v1.0/webhooks

Headers

Authorizationstring required

Bearer [access_token]

Response

Webhook subscriptions for the team (may be empty).

subscribeIdinteger required

the subscribe id

teamIdinteger required

The ID of the team to get

listIdinteger required

The ID of the list to get

vendorIdinteger

The ID of the vendor

callbackUrlstring required

The url link that you receive information

limitinteger

limitation of webhook notifications in 30 mins for each, max is 5000

permissionModeinteger

Recipient resolution mode. 0 = assignment-based (default); 1 = ownership-based (also delivers leads the subscriber manages by team/office/personal ownership).

Example response

[
  {
    "subscribeId": 1234,
    "teamId": 13233324,
    "listId": 1,
    "vendorId": 123,
    "callbackUrl": "http://xxx.test.com",
    "limit": 100
  }
]