Підписка на подію

Функція 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
}