webhook/get

Метод возвращает установленный обработчик оповещений о событиях.

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

POST /ru/transactional/api/v1/webhook/get.json
{
  "api_key": "apiKey",
  "url": "http:\/\/example.org"
}

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


{
    "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 22:56:40",
        "events": {
            "spam_block": [
                "*"
            ],
            "email_status": [
                "delivered"
            ]
        }
    }
}

 

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

Название Тип Описание
api_key Обязательная строка API-ключ пользователя
url Обязательная строка Cтрока с URL, на который будет отправляться запрос при возникновении события (идентификатор обработчика)

 

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

Название Тип Описание
status Обязательная строка Значение "success"
object Обязательный объект Объект, который включает параметры оповещения
object.id Обязательное целое число Идентификатор обработчика
object.url Обязательная строка

Cтрока с URL, на который будет отправляться запрос при возникновении события
object.status Обязательная строка

Текущий статус обработчика:

  • active - обработчик активен и в рабочем состоянии
  • disabled - обработчик отключен пользователем
  • stopped - обработчик остановлен системой, т.к. принимающая сторона в течение последних 24 часов ни разу не отдала корректный ответ 200 OK (и при этом вызовов было не менее 10).
object.events Обязательный объект Массив установленных событий
object.events[n].email_status Обязательный массив Установленные статусы сообщений, по которым будут приходить уведомления
object.events[n].spam_block Обязательный массив Cобытия, связанные со спам-блокировкой
object.event_format Обязательная строка Заданный формат, в котором будут присылаться оповещения
"json_post" или "json_post_gzip"
object.delivery_info Обязательный 1/0
  • 1 - детальная информация о доставке и причинах недоставки (если status равен hard_bounced или soft_bounced, будет возвращена информация о причинах недоставки; если status равен opened или clicked, будет возвращен ip-адрес получателя и информация о браузере и операционной системе получателя);
  • 0 - детальная информация о причинах недоставки (когда status = hard_bounced, soft_bounced, opened, clicked) не будет возвращена

object.updated_at

 Обязательная строка Дата и время последнего обновления обработчика
object.single_event Обязательный 1/0
  • 1 - оповещение Webhook не содержит массивов, за одно оповещение информация будет возвращаться только по одному событию;
  • 0 - оповещение Webhook возвращает информацию в виде массивов
object.max_parallel Обязательное целое число Максимальное количество параллельных запросов на сервер. Допустимые значения: от 5 до 100. По умолчанию: 10

 

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

status - строка "error"

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

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

Код Значение Как исправить
304 Не удалось найти Webhook с указанным URL Убедитесь в правильности передаваемого URL
305 URL не передан Убедитесь в правильности передаваемого URL