setWebhook

Настройка оповещений. Оповещения будут присылаться по URL, указанному при конфигурации. В теле запроса будет присутствовать webHookKey, который позволит идентифицировать источник оповещения на принимающей стороне. В ответ на запрос сервер ожидает 200 HTTP ответ. Если ответ поступил в другом виде (например сервер недоступен), или настройки для получения оповещений не были заданы, или мы просто не получили ответ в течение 60 секунд, то сервер оповещений LiveTex повторяет запрос. LiveTex пробует доставить уведомление в течение 24 часов.

Подсказака: Проверить работу webhook-ов поможет, например, ресурс https://requestb.in/
На главной странице нажмите кнопку "Create a RequestBin" и на открывшейся странице скопируйте адрес из поля Bin URL. Скопированный URL установите для получения оповещений при помощи метода setWebhook. Когда от LiveTex начнут поступать оповещения, вы сможете их видеть, если пройдёте в браузере по этому же URL. Если никакие данные не поступили, то вы увидите только надпись "Ok" на белом фоне.
Обратите внимание, что выдаваемые данным ресурсом адреса доступны временно.

Пример

curl -X POST -d '{"url": "https://example.com/webhooks", "webhook_key": "zbb5y4PZ98R8fW4w"}' \
  https://messaging.livetex.ru/<version>/setWebhook?key=<authentication_key>

Формат запроса

Имя	Тип	Обязательный	Комментарий
url	String	Да	URL, по которому будут отсылаться WebHooks оповещения. Поддерживаются только HTTPS соединения. Самоподписанные сертификаты не поддерживаются.
webhook_key	String	Да	Ключ аутентификации передаваемый во всех сообщениях оповещения

Формат ответа

Имя	Тип	Обязательный	Комментарий
success	Boolean	Да	Проверка успешности выполнения запроса
error_message	String	Нет	Описание ошибки.
error_code	Integer	Нет	Код ошибки. Для возможности интернационализации