When you set up a webhook, LACRM will send a POST to a URL you specify, triggered by specific user actions in the CRM. You can read an explanation of how they work here.

Create a webhook

This function will add a new webhook to your account.

How to call this function

Function name

CreateWebhook

Parameters

EndpointUrl Text Required

URL of webhook target. Must be HTTPS and respond to an initial handshake request; read more here

Events Array of strings Required

List of events that will trigger send. Read about the list of possible options here.

WebhookScope Enum Required

Valid options: User, Account

'User' to report events for just this user, or 'Account' for all users on the account.

Expand

Response

{

"WebhookId": "3952679292106192789911700900724"

}

Expand

Get a webhook

This function will return information about a specific webhook on your account.

How to call this function

Function name

GetWebhook

Parameters

WebhookId Uid Required

ID of webhook to get.

Expand

Response

{

"WebhookId": "3952679292108498632920912879524",

"EndpointUrl": "https://www.mysite.com/webhooks/012345",

"LastSendDate": "2024-04-27T00:03:10-07:00",

"SubscribedEvents": [

"Contact.Create",

"PipelineItemStatus.Create"

"DateArchived": "2024-04-27T00:03:10-07:00"

}

Expand

List all webhooks

This function will return information about all webhooks on your account.

How to call this function

Function name

GetWebhooks

Parameters

IncludeArchived Bool Default: false

If true, will include archived webhooks.

Expand

Response

[

{

"WebhookId": "3952679292108498632920913194536",

"EndpointUrl": "https://www.mysite.com/webhooks/012345",

"LastSendDate": "2024-04-27T00:03:10-07:00",

"SubscribedEvents": [

"Contact.Create",

"PipelineItemStatus.Create"

"DateArchived": "2024-04-27T00:03:10-07:00"

{...},

{...}

]

Expand

Delete a webhook

This function will delete a specific webhook on your account.

How to call this function

Function name

DeleteWebhook

Parameters

WebhookId Uid Required

ID of webhook to delete.

Expand

Response

This function doesn't return anything. If there's no error message returned, that means the call was completed successfully.

Expand