В данном разделе описывается работа с вебхуками через API.
Информация про формат получаемых хуков доступна тут

Оглавление

• Общая информация

• Список установленных вебхуков в аккаунте

• Подписка на вебхук

• Отписка от событий

• Возможные события

Общая информация

• В одном аккаунте может быть не более 100 хуков
• Один вебхук может быть подписан на несколько событий

Список установленных вебхуков в аккаунте

Метод

GET /api/v4/webhooks

Описание

Метод позволяет получить список установленных вебхуков в аккаунте.

Ограничения

Метод доступен с правами администратора аккаунта.

GET параметры

Заголовок типа данных при успешном результате

Content-Type: application/hal+json

Заголовок типа данных при ошибке

Content-Type: application/problem+json

HTTP коды ответа

Параметры ответа

Метод возвращает коллекцию моделей вебхуков, рассмотрим ниже свойства модели.

Пример ответа

{
    "_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.ru/amoWebHook",
                "created_at": 1576157524,
                "updated_at": 1585816857,
                "account_id": 321321,
                "created_by": 123123,
                "sort": 2,
                "disabled": true,
                "settings": [
                    "update_lead"
                ]
            }
        ]
    }
}

Подписка на вебхук

Метод

POST /api/v4/webhooks

Описание

Метод позволяет подписываться на события, информация о которым придет на указанный адрес.

Ограничения

Метод доступен с правами администратора аккаунта.

Заголовок запроса

Content-Type: application/json

Параметры запроса

Для подписки на события необходимо передать обязательные параметры destination и settings. Если в аккаунте уже есть вебхук с переданным адресом, то он будет обновлен с переданными настройками.

Пример запроса

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

Заголовок типа данных при успешном результате

Content-Type: application/hal+json

Заголовок типа данных при ошибке

Content-Type: application/problem+json

HTTP коды ответа

Параметры ответа

Метод возвращает объект вебхука, который были созданы. Свойства аналогичны тем, что приходят в методе получения списка.

Пример ответа

{
    "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"
    ]
}

Отписка от событий

Метод

DELETE /api/v4/webhooks

Описание

Метод позволяет отписать вебхук от получения любых событий.

Ограничения

Метод доступен только с правами администратора аккаунта.

Заголовок запроса

Content-Type: application/json

Параметры запроса

Для отмены подписки на события необходимо передать обязательный параметр destination.

Пример запроса

{
    "destination": "https://example.test"
}

HTTP коды ответа

Параметры ответа

Метод не возвращает тело

Возможные события