Вебхуки повідомлень

Повний список усіх подій повідомлення, на які ви можете підписатися.
Написано Микола
Оновлено 7 місяців тому

Наразі ви можете підписатися лише на події чату, контакту і повідомлення. Усі події вебхуків містять однакові атрибути, перелічені нижче:

Поле Тип Опис
event String Тип чату або події контакту
eventData Object Контейнер для даних, пов’язаних із подією
attempts Integer Кількість спроб цієї події
lastAttemptAt Date (UNIX timestamp) Остання спроба доставки події
createdAt Date (UNIX timestamp) Дата і час створення події
id String Унікальний ідентифікатор події, наданий HelpCrunch

📢 Події повідомлення

Тип події Опис
message.chat.customer Нове вхідне повідомлення чату, надіслане контактом
message.email.customer Нове вхідне повідомлення електронної пошти, надіслане контактом
message.private Нове приватне повідомлення надіслане учасником команди
message.chat.agent Нове повідомлення чату надіслано учасником команди
message.email.agent Нове повідомлення електронної пошти, надіслане членом команди

Коли відбувається подія повідомлення, HelpCrunch надсилає запит HTTP до вказаної кінцевої точки. Ви можете отримати всі доступні атрибути повідомлення зі структури eventData в тілі запиту, включаючи основну інформацію про контакт (ідентифікатор, ім’я, електронна адреса та userId) та чат (ідентифікатор).

Модель повідомлень для вебхуків

Приклад відповіді:

{
    "event": "message.chat.customer",
    "eventData": {
      "chat_id": 5224081,
      "agent": null,
      "customer": {
        "id": 8745474,
        "name": "Paul",
        "email": "[email protected]",
        "userId": "example_9106"
      },
      "message": {
        "applicationId": 77,
        "broadcastType": null,
        "createdAt": "1638953586.915",
        "edited": false,
        "id": 38488,
        "read": false,
        "text": "Thanks! Have a nice day.",
        "updatedAt": "1638953586.915"
        }
      },
    "attempts": 0,
    "lastAttemptAt": 1638953588,
    "createdAt": 1638953588,
    "id": "73499e69-285c-44c3-8431-a843ed08183d"
  }

Об'єкт eventData для подій повідомлення

Поле Тип Опис
event String Тип події
chat_id Integer Унікальний внутрішній ідентифікатор чату
agent Object

Інформація про члена команди, включаючи:

  • унікальний внутрішній ідентифікатор члена команди
  • ім'я
  • email
  • роль
customer Object

Основна інформація про контакт, включаючи:

  • унікальний внутрішній ідентифікатор контакту в системі HelpCrunch
  • ім'я
  • email
  • власний унікальний ідентифікатор контакту, який ви можете передати до HelpCrunch за допомогою автентифікації користувача
message Object

Інформація про повідомлення, зокрема:

  • унікальний внутрішній ідентифікатор повідомлення
  • унікальний внутрішній ідентифікатор застосунку, який був використаний для відправки повідомлення контактом (для отримання інформації про цей застосунок використовуйте GET метод "Отримати всі застосунки" у REST API)
  • текст або унікальний внутрішній ідентифікатор вкладення
  • статус прочитання
  • Дата і час створення повідомлення (помітка часу UNIX)
Ви можете використовувати ідентифікатор чату та ідентифікатор контакту з будь-якої події повідомлення, щоб викликати методи REST API "Отримати інформацію про чат" та "Отримати інформацію про контакт".
Чи була наша стаття корисною?