Subscription to an event

Function hooks/subscribe (http://<DOMAIN>/api/hooks/subscribe/)

Parameters:

• token - authorization key obtained through the auth function

• event - event name
  • order_created - event triggered when a user places an order or shop admin creates an order in the admin panel
  • user_signup - event triggered at user registration
    

  • request_call_me - event triggered when a callback request is made
    

• target_url - link where data should be sent when the event is triggered
  

Response:

• id - hook identifier to be stored for unsubscribing from the webhook

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

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

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

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

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

{
    "id": 1
}