Вебхук об изменении статуса сообщения
Этот вебхук позволяет получать информацию об изменении статусов обработки и доставки сообщений. При изменении статуса сообщения edna Pulse отправляет HTTP POST-запрос на указанный URL-адрес вашей системы. В статье описаны формат вебхука и передаваемые данные.
Настройка URL-адреса
Чтобы установить URL-адрес для вебхука об изменении статуса сообщения, отправьте POST-запрос на URL-адрес https://app.edna.by/api/callback/set.
Ваш URL-адрес должен быть реальным и доступным для запроса из публичного интернета. Используйте только безопасный протокол HTTPS — по умолчанию TCP-порт 443. Максимальная длина URL-адреса — 500 символов.
Если доставка вебхука завершается ошибкой, edna Pulse выполняет до трёх повторных попыток отправки по схеме backoff: через 4, 128 и 2048 секунд после предыдущей попытки.
Также URL-адрес вебхука можно указать в личном кабинете edna Pulse: Интеграция → Настройка → Основной профиль → Webhook-URL для статусов.
Общая информация про API-ключи и вебхуки edna Pulse Управление вебхуками edna PulseПример вебхука
{
"requestId": "test-00135",
"messageId": 8681748,
"cascadeId": 11,
"cascadeStageUUID": "001-test001",
"subject": "test_subject",
"subjectId": 2,
"status": "DELIVERED",
"statusAt": "2025-01-30T11:07:55Z",
"error": null,
"comment": null
}
Параметры вебхука
| Параметр | Тип данных | Характер | Описание |
|---|---|---|---|
requestId | string | Обязательный | Идентификатор запроса, на основании которого формируется и отправляется сообщение. |
cascadeId | long | Обязательный | Идентификатор каскада. |
cascadeStageUUID | string | Обязательный | null или данные. |
subject | string | Обязательный | Название подписи. |
subjectId | long | Обязательный | Идентификатор подписи. Можно узнать через метод получения списка каналов. Получение списка каналов |
status | string | Обязательный | Статус сообщения. |
statusAt | string | Обязательный | Время последнего обновления статуса сообщения. Указывается в формате ISO 8601. Например: 2023-10-31T11:07:56Z. |
error | string | Необязательный | null или данные. Ошибка при доставке сообщения. |
comment | string | Необязательный | Текстовый комментарий. Указывается при отправке сообщения. Значение параметра также отображается в детальном отчете. Может использоваться для маршрутизации чат-ботов. |
Ожидаемый формат ответа
В ответ на запрос от вашего сервера должен возвращаться статус его выполнения с кодом 200.