webhook/set

Метод для установки или редактирования обработчика оповещения о событиях. Оповещения можно получать в формате “json_post”, “json_post_gzip”.

Webhook могут оповещать о таких событиях:

• отправленное письмо получило статус (статусы, о которых следует уведомлять, настраиваются при установке Webhook);

• спам-блокировка

Тестовый запрос

POST /ru/transactional/api/v1/webhook/set.json

{
  "api_key": "apiKey",
  "url": "https:\/\/example.org",
  "status": "active",
  "event_format": "json_post",
  "delivery_info": 1,
  "single_event": 0,
  "max_parallel": 10,
  "events": 
  {
    "email_status":
    [
      "sent",
      "delivered",
      "opened",
      "hard_bounced",
      "soft_bounced",
      "spam",
      "clicked",
      "unsubscribed"
    ],
    "spam_block":
    ["*"]
  }
}

Пример удачного выполнения запроса

{
    "status": "success",
    "object": {
        "id": 1,
        "url": "https://example.org",
        "status": "active",
        "event_format": "json_post",
        "max_parallel": 10,
        "single_event": 0,
        "delivery_info": 1,
        "updated_at": "2020-12-08 11:02:27",
        "events": {
            "spam_block": [
                "*"
            ],
            "email_status": [
                "sent",
                "delivered",
                "opened",
                "hard_bounced",
                "soft_bounced",
                "spam",
                "clicked",
                "unsubscribed"
            ]
        }
    }
}

Параметры запроса

Поля успешного результата

Доступны следующие статусы для уведомления (значения переменной "email_status"):

sent — сообщение отправлено, но пока не доставлено.

delivered — сообщение доставлено. Может измениться на “opened” и “clicked”.

opened — сообщение доставлено и зарегистрировано его прочтение. Может измениться на “clicked”.

clicked — сообщение доставлено, прочитано, был зарегистрирован переход по одной из ссылок в письме.

unsubscribed — сообщение было доставлено получателю и прочитано им, но пользователь отписался по ссылке в письме. Статус окончательный.

soft_bounced — не удалось доставить сообщение по одной из следующих причин:

• попытки отправки не производились, или отправка отложена;

• ящик адресата переполнен;

• письмо было отвергнуто сервером получателя как спам;

• было не менее одной попытки отправки, попытки продолжаются;

• домен получателя не принимает почту из-за неправильных настроек;

• отправка была отменена;

• отправка отменена из-за некорректных данных отправителя;

• не хватает средств на счету;

• адрес временно недоступен.

hard_bounced — не удалось доставить сообщение по одной из следующих причин:

• почтовый ящик адресата не существует, либо удален;

• email-адрес не используется;

• домен получателя не принимает никакую почту вообще по любой причине;

• некорректный адрес получателя;

• адресат отписался от Ваших рассылок;

• email-адрес недоступен;

• письмо превышает допустимый размер;

• истек срок повторных отправок сообщения.

spam — сообщение доставлено, но отмечено “как спам” получателем. UniOne может получить и обработать жалобу о спаме (используя технологию fbl) от таких доменов:

• mail.ru;
• msn.com, outlook.com, hotmail.com, live.com;
• ukr.net;
• yahoo.com;
• aol.com.

Поля ошибочного результата

status - строка "error"

message - сообщение об ошибке на английском

code - один из общих кодов ошибок.