Mindbox

Вебхуки

Вебхуки — это механизм, с помощью которого можно вызывать произвольные http-сервисы при наступлении определённых событий.

Например:

  • передать внешней системе, что нужно начислить баллы клиенту за брошенную корзину.
  • поставить задачу в коллцентр о том, что нужно обзвонить неактивного клиента.
  • передать статусы подписки клиента в учётную систему.

Требования к веб-сервису

  • Поддерживаемые http-методы: GET, POST, PUT, PATCH и DELETE
  • Поддерживаемые методы авторизации: Basic, Bearer
  • URI запроса, http-заголовки и тело запроса произвольные, при формировании доступен язык шаблонизатора.
  • Если вызов отправляется на https-сервис, то этот сервис должен иметь валидный сертификат.

Идемпотентность

Чтобы избежать повторной обработки вызова веб-сервисом (например, повторных начислений баллов), необходимо использовать вебхуки с ключом идемпотентности ${WebhookRequest.TransactionalId}.

Идемпотентность работает следующим образом:

  • сервис внешней системы возвращает код ответа 2xx Success → вызов считается успешным и повторен не будет;
  • сервис внешней системы не дает ответ в течение 30 секунд или возвращает ответы 5xx или 429 → вызов повторится максимум 3 раза в течение 6 минут;
  • сервис внешней системы возвращает другой ответ → вызов не повторяется.

Логи

Логи всех отправок вместе с ответами хранятся на проекте 30 суток.

Также их можно выгрузить по API.

Примеры

JSONИзменение статуса подписки
https://www.yandex.ru/api/mindbox/unsubscribe?transactionId=${WebhookRequest.TransactionalId} Content-Type: application/json Authorization: Mindbox key="90zm16D6B58B42C" { "customer": { "mindboxId": "${Recipient.Id}", "email": @{if Recipient.Email != null} "${Recipient.Email}" @{else} "" @{end if}, "mobilePhone": @{if Recipient.MobilePhone != null} "${Recipient.MobilePhone}" @{else} "" @{end if}, "UserWebSiteId": @{if Recipient.CustomField.UserWebSiteId != null} "${Recipient.CustomField.UserWebSiteId}" @{else} "" @{end if} }, "unsubscribedDateTimeUtc": "${WebhookRequest.DateTimeUtc}" }
XMLНачисление баллов
https://www.yandex.ru/api/mindbox/balance?transactionId=${WebhookRequest.TransactionalId} Content-Type: text/xml Authorization: Basic 0LzQsNC50L3QtNCx0L7QutGBOtC60YDRg9GC0L7QuQ== <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <Process> <BonusRequest> <DateTime>${ Formatdatetime(WebhookRequest.DateTimeUtc,"s") }</DateTimeTz> <RequestID>${WebhookRequest.TransactionalId}</RequestID> <Card> <CardNumber>${Recipient.AdditionalData.cardNumbers}</CardNumber> </Card> <Description>Поощрение за отзывы на сайте</Description> </BonusRequest> </Process> </soap:Body> </soap:Envelope>
Last modified on