Вебхуки #
Методы для работы с подписками на вебхуки описаны в OpenAPI-документации: #
- POST /webhooks - создание подписки на событие
- GET /webhooks - вывод списка всех подключенных подписок на события
- DELETE /webhooks/{uuid} - удаление подписки
Доступные типы событий и описание запросов: #
- Событие обновления статуса (ORDER_STATUS)
- Событие обновления номера заказа (ORDER_NUMBER_UPDATE)
- Событие обновления плановой даты доставки (PLANNED_DELIVERY_DATE_UPDATE)
Подписки на типы событий независимы: можно включить любые из них, например только PLANNED_DELIVERY_DATE_UPDATE. На каждый тип допускается одна подписка. Если несколько типов подписаны на один адрес, события ORDER_NUMBER_UPDATE и PLANNED_DELIVERY_DATE_UPDATE различаются по полю eventType.
Проверка, что вебхук пришёл от ApiShip #
При создании подписки можно задать заголовок авторизации — секрет, по которому ваш приёмник проверит, что запрос отправил ApiShip:
| |
authHeaderValue— значение заголовка. Без переводов строки, до 1024 символов.authHeaderName— имя заголовка, необязательное, по умолчаниюAuthorization. Допустимы латинские буквы, цифры и символы!#$%&'*+-.^_`|~. ЗадатьHost,Content-TypeилиContent-Lengthнельзя.
Заголовок приходит в каждом вебхуке этой подписки, в том числе в повторных отправках. Если ваш адрес отвечает редиректом на другой хост, схему или порт (например, с http на https), заголовок туда не передаётся — указывайте в подписке конечный адрес. У каждой подписки свой заголовок: для разных типов событий можно задать разные секреты. GET /webhooks возвращает имя и значение заголовка каждой подписки.
Чтобы сменить секрет, удалите подписку и создайте её заново с новым значением, или обратитесь в поддержку. Если заголовок не задан, вебхук приходит только с Content-Type: application/json.