Подписка на событие

Функция hooks/subscribe (http://<DOMAIN>/api/hooks/subscribe/)

Параметры:

  • token - ключ авторизации полученный через функцию auth

  • event - название события
    • order_created - событие срабатывающее при оформлении пользователем заказа либо при создании заказа в админ. панели
    • user_signup - событие срабатывающее при регистрации пользователя
    • request_call_me - событие срабатывающее при запросе обратного звонка

  • target_url - ссылка по которой необходимо отправить данные при срабатывании события

Ответ:

  • id - идентификатор хука, который необходимо сохранить для отписки от вебхука

Также, при успешной подписке на вебхук сервер вернёт заголовок HTTP/1.1 201 Created что означает что вебхук успешно создан, при других статусах ответа сервера отличных от 20х следует считать что подписка не удалась.

Максимальное количество подписок на одно событие - 5. При достижении этого лимита ответ сервера будет "Subscriptions limit for current event has been reached"


Пример запроса по адресу http://<DOMAIN>/api/hooks/subscribe/

JSON
{
	"token": "<ВАШ ТОКЕН>",
	"event": "order_created",
	"target_url": "http://your_crm.com/order/created"
}


Пример ответа на запрос:

JSON
{
    "id": 1
}