Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

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

Пример ответа на запрос:Приклад відповіді на запит

Code Block
languagejs
titleJSON
{
    "id": 1
}

...