v1

latestOpenAPI 3.0.12026-07-22120163333.7 KB

Webhooks

Create Webhook

Subscribes the caller's team to a webhook event type. See the Webhooks tag description for the full list of event types and delivery rules. For detailed payload shapes per event type, see Webhook Event Payloads.

post/v1.0/webhook

Headers

Authorizationstring required

Bearer [access_token]

Content-Typestring required

application/json

Request body

listId1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 required

Event type to subscribe to. See the Webhooks tag description for the full list of supported event types.

callbackUrlstring required

Callback URL that receives event payloads. Must be HTTPS and reachable from the Lofty backend.

limitinteger

Maximum number of events to include in a single callback batch. Default 100, maximum 5000.

permissionMode0 | 1

Recipient resolution mode. 0 = assignment-based (default): callbacks fire for leads assigned to the subscribing user, or for company owners/admins. 1 = ownership-based: callbacks also fire for any lead the subscribing user manages by ownership (their team / office / personally owned), regardless of direct assignment.

Example request

{
  "listId": 2,
  "callbackUrl": "https://example.com/webhooks/lofty",
  "limit": 100
}

Response

Subscription created. The response contains the new subscription's metadata.

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
}