Перейти к основному содержимому

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

Обновлено: 29 мая 2026

API-ключи​

API-ключ — это способ авторизации при работе с API edna Pulse. Определяет доступ к данным и методам API.

подсказка

В edna Pulse используются два типа API-ключей — основной и дополнительный.

File IconКак выбрать подходящий тип API-ключа и вебхука File IconУправление API-ключами для интеграции с API edna Pulse

Основной API-ключ​

  • Генерируется вручную на вкладке Интеграция → Настройки → Основной профиль в личном кабинете edna Pulse.
  • Предоставляет доступ ко всем данным личного кабинета и ко всем методам API edna Pulse.
  • Может быть только один для одного личного кабинета.
  • Нельзя удалить, но можно сгенерировать новый.
  • Нельзя задавать срок действия ключа.

Дополнительные API-ключи​

  • Генерируются вручную на вкладке Интеграция → Настройки → API-ключ в личном кабинете edna Pulse.
  • Можно предоставить доступ ко всем или только к выбранным каналам и группам методов API edna Pulse.
  • Может быть несколько в рамках одного личного кабинета.
  • Можно задавать срок действия ключа и удалять его.
  • Можно использовать как один API-ключ для одного канала, так и один API-ключ для нескольких каналов.
  • Ограничения ключа применяются ко всем запросам, выполненным с его использованием.
  • Один канал может быть привязан только к одному дополнительному API-ключу.
  • Для одного канала может использоваться только один дополнительный API-ключ совместно с основным API-ключом.

Вебхуки​

Вебхук — это уведомление о событии, которое edna Pulse отправляет на URL-адрес другой системы в режиме реального времени.

подсказка

В edna Pulse используются два типа вебхуков — основные и дополнительные.

File IconКак выбрать подходящий тип API-ключа и вебхука File IconУправление вебхуками edna Pulse

Типы событий для вебхуков​

Вебхуки настраиваются по типам событий. Поддерживаемые типы событий:

  • Изменение статусов сообщений — для каналов WhatsApp, Viber, SMS, Notify, MAX Bot, MAX.
  • Изменение статусов шаблонов — для каналов WhatsApp, Viber, SMS, Notify.
  • Входящие сообщения — для каналов WhatsApp, Viber, MAX Bot, MAX.
  • Изменение категорий шаблонов — только для каналов WhatsApp.
  • Переходы по кнопкам-ссылкам в сообщениях — только для каналов WhatsApp.

Настройте отправку вебхуков в зависимости от требований вашей системы:

  • один URL — для всех типов событий;
  • разные URL — для разных типов событий;
  • один URL — для всех типов событий по выбранным каналам;
  • разные URL — для разных типов событий по выбранным каналам;
  • для каждого типа события в рамках одного канала можно указать до двух URL-адресов.

Основные вебхуки​

  • Настраиваются вручную на вкладке Интеграция → Настройки → Основной профиль в личном кабинете edna Pulse или по API.
  • Действуют на весь личный кабинет.
  • Каждый основной вебхук обрабатывает только свой тип события во всех каналах личного кабинета.
  • Применяются ко всем каналам.
  • Основные вебхуки отправляются события только по тем каналам, для которых не настроены дополнительные вебхуки.
  • Можно удалять или изменять URL-адрес для каждого типа события.

Дополнительные вебхуки​

  • Настраиваются вручную на вкладке Интеграция → Настройки → Вебхуки в личном кабинете edna Pulse или по API.
  • Могут применяться к выбранным каналам.
  • Если для канала настроен дополнительный вебхук, события по этому каналу отправляются только через него.
  • Позволяют задавать отдельные параметры обработки событий.
  • Для каждого типа события в рамках одного канала можно указать до двух URL-адресов.
  • Можно удалять или изменять URL-адреса для настроенных вебхуков.