Webhooks

Webhooks — это механизм, который позволяет сделать HTTP POST-запрос на указанный вами URL при возникновении нужных условий. Webhooks настраиваются в разделе "Интеграции" в панели администратора.

На данный момент у нас имеются следующие типы webhooks:

  1. После совершения события

После совершения события

type=event
token=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
user={ ... }
user_id=7183415
event_name=My Event
event={ ... }

Этот webhook будет вызван после совершения выбранных вами событий.

Параметр type будет содержать значение event.

user будет содержать сериализованный в JSON объект User (пользователь, совершивший событие).

user_id содержит ID пользователя.

event будет содержать объект Event (произошедшее событие).

event_id содержит ID события.

event_name содержит название события.

Автосообщение с типом "Триггерный webhook"

В теле не будет параметра event_name

Добавятся дополнительные параметры:

message_id - id автосообщения

sending_id - id диалога

message_name - Название автосообщения

В type будет записано message_webhook

В остальном содержимое идентично.


Примечания

Система будет делать HTTP POST-запрос (закодированный в application/x-www-form-urlencoded) на указанный URL.

Все запросы содержат поля type (тип webhook) и token. Чтобы удостовериться, что запрос пришел именно от нас, обязательно проверьте что token совпадает с токеном в панели администратора.

Для подтверждения доставки уведомления необходимо ответить статусом 200 OK. В случае ошибки или другого статуса запрос будет повторен несколько раз через некоторое время.