Вебхук об изменении статуса отправителя
Этот вебхук позволяет получать информацию об изменении состояния канала. При создании, активации или отключении канала 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: Интеграция → Настройка → Основной профиль → Вебхук для изменения статуса отправителя.
Общая информация про API-ключи и вебхуки edna Pulse Управление вебхуками edna PulseФормат вебхука
{
"type": "string",
"payload": {
"sender": "string",
"status": "string",
"details": "string"
},
"version": "string",
"timestamp": "string"
}
Примеры вебхуков
Канал создан
{
"type": "sender#created",
"payload": {
"sender": "sender_example",
"status": "ACTIVE"
},
"version": "v1",
"timestamp": "2026-04-16T12:34:00.320Z"
}
Канал подключён и активен
{
"type": "sender#unlocked",
"payload": {
"sender": "sender_example",
"status": "ACTIVE"
},
"version": "v1",
"timestamp": "2026-04-16T12:34:02.160Z"
}
Канал отключён или заблокирован
{
"type": "sender#locked",
"payload": {
"sender": "sender_example",
"status": "LOCKED",
"details": "license expired"
},
"version": "v1",
"timestamp": "2026-08-14T15:06:00.320Z"
}
Параметры вебхука
| Параметр | Тип данных | Характер | Описание |
|---|---|---|---|
payload | object | Обязательный | Информация о типе события.
Возможные значения: - sender#created — канал создан.
- sender#unlocked — канал подключён и активен.
- sender#locked — канал отключён или заблокирован. |
payload.sender | string | Обязательный | Название канала.
Чтобы узнать название канала, используйте метод API для получения списка каналов — параметр subject.
Получение списка каналов |
payload.status | string | Обязательный | Статус канала.
Возможные значения: - ACTIVE — подключён и активен.
- LOCKED — отключён или заблокирован. |
payload.details | string | Необязательный | Причина отключения или блокировки канала. Только если payload.status=LOCKED.
Возможные значения: - license expired — срок лицензии на использование канала истёк.
- license cancelled — лицензия на использование канала отменена.
- temporary tenant blocked — личный кабинет временно заблокирован.
- tenant blocked — личный кабинет заблокирован. |
type | string | Обязательный | Тип события, о котором отправляется вебхук. |
version | string | Обязательный | Версия вебхука с учётом типа события. |
timestamp | string | Обязательный | Время обновления состояния канала. Указывается в формате ISO 8601 (например, 2025-07-01T00:00:00Z). |
Формат ответа
В ответ на запрос от вашего сервера должен возвращаться статус его выполнения с кодом 200.