WebHooks

In this section we will describe all available methods for working with Webhooks via API.

You can read more about the webhooks format here

Table of Contents

• Common information
• List of webhooks
• Adding webhooks
• Deleting a webhook
• Webhook events

Common information

• The number of webhooks on one account is limited to 100
• One webhook can be associated with several events

List of webhooks

Method

GET /api/v4/webhooks

Description

This method allows to get a list of webhooks on the account.

Limitations

Method is available for administrator users only.

GET parameters

Data type header when the request is successful

Content-Type: application/hal+json

Data type header in case of an error

Content-Type: application/problem+json

HTTP response codes.

Response parameters

Method returns a collection of webhook models. The properties of the model are listed below

Response example

{
    "_total_items": 2,
    "_embedded": {
        "webhooks": [
            {
                "id": 839656,
                "destination": "https://webhook-uri.com",
                "created_at": 1575539157,
                "updated_at": 1575539157,
                "account_id": 321321,
                "created_by": 123123,
                "sort": 1,
                "disabled": false,
                "settings": [
                    "add_task"
                ]
            },
            {
                "id": 849193,
                "destination": "https://api.test.com/amoWebHook",
                "created_at": 1576157524,
                "updated_at": 1585816857,
                "account_id": 321321,
                "created_by": 123123,
                "sort": 2,
                "disabled": true,
                "settings": [
                    "update_lead"
                ]
            }
        ]
    }
}
        

Adding webhooks

Method

POST /api/v4/webhooks

Description

This method allows to create a webhook to receive event notifications to the specified URL.

Limitations

Method is available for administrator users only.

Request header

Content-Type: application/json

Request parameters

To create a webhook, “destination” and “settings” parameters should be passed. If a webhook with the passed destination already exists, it will be updated corresponding to the passed settings.

An example of the request

{
    "destination": "https://example.test",
    "settings": [
        "add_lead"
    ],
    "sort": 10
}
        

Data type header when the request is successful

Content-Type: application/hal+json

Data type header in case of an error

Content-Type: application/problem+json

HTTP response codes.

Response parameters

Method returns the added webhook model. The properties of the model are similar to the model returned in the Webhooks List request responce.

Response example

{
    "id": 1056949,
    "destination": "https://example.test",
    "created_at": 1589012268,
    "updated_at": 1589012268,
    "account_id": 321321,
    "created_by": 3944275,
    "sort": 1,
    "disabled": false,
    "settings": [
        "add_lead"
    ]
}
        

Deleting a webhook

Method

DELETE /api/v4/webhooks

Description

This method allows to delete a webhook.

Limitations

Method is available for administrator users only.

Request header

Content-Type: application/json

HTTP response codes.

Response parameters

Method does not return a body

Webhook events