Установка URL-адресов для вебхуков

Обновлено: 27 августа 2026

Для установки URL-адреса вебхука используется метод api/callback/set. В edna Pulse доступно два типа вебхуков — основные и дополнительные.

Общая информация про API-ключи и вебхуки edna Pulse

к сведению

При необходимости вы можете включить аутентификацию вебхуков в личном кабинете edna Pulse.

Управление вебхуками edna Pulse

Вызов метода

Чтобы установить URL-адрес для вебхука, отправьте POST-запрос на URL-адрес https://app.edna.by/api/callback/set.

подсказка

Для проверки доступности URL-адреса edna Pulse отправит один тестовый HEAD-запрос, на который ожидает получить ответ с кодом 200. Если HEAD-запрос завершается ошибкой, указанный URL-адрес не сохраняется.

к сведению

Если доставка вебхука завершается ошибкой, edna Pulse выполняет до трёх повторных попыток отправки по схеме backoff: через 4, 128 и 2048 секунд после предыдущей попытки.

Формат запроса

{
  "statusCallbackUrls": [
    "string"
  ],
  "inMessageCallbackUrls": [
    "string"
  ],
  "messageMatcherCallbackUrls": [
    "string"
  ],
  "senderStatusCallbackUrl": [
    "string"
  ],
  "subjectIds": [
    "number"
  ]
}

Пример запроса

Настройка основных вебхуков

{
  "statusCallbackUrls": [
    "https://messagesxxx.com/status/webhook/statusCallbackUrls"
  ],
  "inMessageCallbackUrls": [
    "https://messagesxxx.com/status/webhook/inMessageCallbackUrls"
  ],
  "messageMatcherCallbackUrls": [
    "https://messagesxxx.com/status/webhook/messageMatcherCallbackUrls"
  ],
  "senderStatusCallbackUrl": [
    "https://messagesxxx.com/status/webhook/senderStatusCallbackUrl"
  ]
} 

Настройка дополнительных вебхуков

подсказка

Максимальное количество URL-адресов для каждого типа события в рамках одного канала — 2.

{
  "statusCallbackUrls": [
    "https://messagesxxx.com/webhook/statusCallbackUrls/1",
    "https://messagesxxx.com/webhook/statusCallbackUrls/2"
  ],
  "inMessageCallbackUrls": [
    "https://messagesxxx.com/webhook/inMessageCallbackUrls/1"
  ],
  "messageMatcherCallbackUrls": [
    "https://messagesxxx.com/webhook/messageMatcherCallbackUrls/1"
  ],
  "senderStatusCallbackUrl": [
    "https://messagesxxx.com/webhook/senderStatusCallbackUrl/1",
    "https://messagesxxx.com/webhook/senderStatusCallbackUrl/2"
  ],
  "subjectIds": [
    1
  ]
}

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

подсказка

Ваш URL-адрес должен быть реальным и доступным для запроса из публичного интернета. Используйте только безопасный протокол HTTPS — по умолчанию TCP-порт 443. Максимальная длина URL-адреса — 500 символов.

Параметр	Тип данных	Характер	Описание
statusCallbackUrls	array of strings	Необязательный	Список URL-адресов, на которые будут приходить вебхуки о статусе доставки сообщения.
inMessageCallbackUrls	array of strings	Необязательный	Список URL-адресов, на которые будут приходить вебхуки о входящем сообщении.
messageMatcherCallbackUrls	array of strings	Необязательный	Список URL-адресов, на которые будут приходить вебхуки о статусе регистрации шаблона.
senderStatusCallbackUrl	array of strings	Необязательный	Список URL-адресов, на которые будут приходить вебхуки об изменении состояния канала.
subjectIds	array of numbers	Необязательный	Список идентификаторов каналов, для которых необходимо настроить URL-адреса для дополнительных вебхуков. Чтобы узнать идентификатор канала, используйте метод API для получения списка каналов — параметр subjectId. Получение списка каналов Если не указан subjectIds, произойдёт настройка основных вебхуков, максимальное количество URL-адресов для типа события — 1. Общая информация про API-ключи и вебхуки edna Pulse

подсказка

Если указан subjectIds, максимальное количество URL-адресов для типа события в рамках одного канала — 2.

warning

Если параметр subjectId не указан, вебхуки будут настроены для всех каналов. Если указан параметр subjectId, URL-адрес вебхука будет установлен только для канала с указанным идентификатором.

Формат ответа

{
    "code": "string"
}

Пример ответа

{
    "code": "ok"
}

Параметры ответа

Параметр	Тип данных	Описание
code	string	Код ответа на запрос.

Ошибки

Код	Ошибка	Описание
400	callback-url-not-available	URL-адрес не доступен для запроса из публичного интернета. Возможные комментарии: Callback URL is not available — HEAD-запрос, отправленный edna Pulse по указанному URL-адресу, завершился ошибкой.
400	callback-url-not-https	URL-адрес не использует протокол HTTPS. Возможные комментарии: Callback URL is not HTTPS — URL-адрес не использует протокол HTTPS.
400	callback-url-too-long	Длина URL-адреса больше допустимой. Возможные комментарии: Callback URL is too long — URL-адрес содержит более 500 символов.
400	subject-not-found	Канал с указанным идентификатором не найден. Возможные комментарии: Subject is not found — канал с указанным идентификатором не найден.
400	url-not-specified	Отсутствует URL-адрес для вебхука или тип события, для которого настраивается вебхук. Возможные комментарии: Need to specify url — необходимо указать тип события, для которого настраивается вебхук, или URL-адрес для вебхука.