Skip to main content
POST
Create Webhook

Headers

Authorization
string
required

Bearer [access_token]

Content-Type
string
required

application/json

Body

application/json

Webhook subscription payload.

listId
enum<integer>
required

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

Available options:
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
Example:

2

callbackUrl
string
required

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

Example:

"https://example.com/webhooks/lofty"

limit
integer<int32>
default:100

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

Required range: 1 <= x <= 5000
Example:

100

permissionMode
enum<integer>
default:0

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.

Available options:
0,
1
Example:

0

Response

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

subscribeId
integer<int64>
required

the subscribe id

Example:

1234

teamId
integer<int64>
required

The ID of the team to get

Example:

13233324

listId
integer<int32>
required

The ID of the list to get

Example:

1

callbackUrl
string
required

The url link that you receive information

Example:

"http://xxx.test.com"

vendorId
integer<int64>

The ID of the vendor

Example:

123

limit
integer<int32>

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

Example:

100

permissionMode
integer<int32>

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

Example:

0