Вебхуки чату

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

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

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

💬 Події чату

Тип події Опис
chat.new Новий чат, створений будь-яким контактом
chat.status_updated Статус чату оновлюється вручну або автоматично (наприклад, коли член команди відповідає на новий чат і статус автоматично змінюється на "Відкритий")
chat.assigned Відповідальний за чат оновлюється вручну або автоматично (наприклад, коли член команди відповідає і автоматично призначає чат собі)
chat.snoozed Чат відкладено на потім
chat.unsnoozed Відкладання чату скасовано
chat.closed Чат закритий членом команди або контактом
chat.rated Чат оцінений контактом

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

Модель чату для вебхуків

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

{
    "event": "chat.snoozed",
    "eventData": {
      "communicatedAgents": [
        2924
      ],
      "customer": {
        "id": 8745474,
        "name": "Paul",
        "email": "[email protected]",
        "userId": "example_9106"
      },
      "closedBy": "customer",
      "status": "closed",
      "closedAt": "1607542030.713",
      "rating": "great",
      "createdAt": "1607540767.414",
      "snoozedUntil": "1606155714.000",
      "applicationId": 743,
      "applications": [
        743,
        42
      ],
      "department": {
        "id": 233231,
        "name": "Sales"
      },
      "lastCustomerMessageAt": "1607540767.166",
      "chat_id": 5224081,
      "assignee": {
        "id": 2924,
        "name": "Paul",
        "email": "[email protected]",
        "role": "admin"
      },
      "lastMessage": {
        "id": 9685301,
        "text": "set_rating",
        "createdAt": "1607542030.679"
      }
    },
    "attempts": 0,
    "lastAttemptAt": 1607542030,
    "createdAt": 1607542030,
    "id": "252041ed-62a7-4303-81f9-842ec6e8d18f"
  }

Об'єкт eventData для подій чату

Поле Тип Опис
event String Тип івента
communicatedAgents Array of integers Масив ідентифікаторів операторів. Ви можете отримати інформацію про операторів (ідентифікатор, ім’я, адресу електронної пошти, роль) за допомогою методу REST API "Отримати всіх учасників команди".
customer Object

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

  • унікальний внутрішній ідентифікатор контакту в системі HelpCrunch
  • ім'я
  • email
  • власний унікальний ідентифікатор контакту, який ви можете передати до HelpCrunch за допомогою автентифікації користувача
closedBy String Хто закрив чат - "контакт" або "член команди".
closedAt Date (UNIX timestamp) Дата та час закриття чату
status String Поточний статус чату: «новий», «відкритий», «в очікуванні», «на паузі», «закритий», «немає зв’язку», «порожній».
rating String Оцінка чату для закритих чатів: "погано",  "середньо" або "чудово"
createdAt Date (UNIX timestamp) Дата і час створення чату
snoozedUntil Date (UNIX timestamp) Дата й час, до якого час було відкладено
applicationId Integer Унікальний внутрішній ідентифікатор застосунку. Ви можете отримати інформацію про застосунок (ідентифікатор, ім’я, активний, тип) за допомогою методу REST API "Отримати всі застосунки".
applications Array Всі унікальні внутрішні ідентифіктори застосунків, які використовував контакт для відправки повідомлень у чат. Ви можете отримати інформацію про застосунок (ідентифікатор, ім’я, активний, тип) за допомогою методу REST API "Отримати всі застосунки".
department Object Відділ, до якого наразі призначено чат. Складається з унікального внутрішнього ідентифікатора в системі HelpCrunch та назви відділу.
lastCustomerMessageAt Date (UNIX timestamp) Дата та час останнього повідомлення від контакту
chat_id Integer Унікальний внутрішній ідентифікатор чату в системі HelpCrunch
assignee Object Член команди, якому зараз призначено чат. Складається з унікального внутрішнього ідентифікатора члена команди в системі HelpCrunch, імені, електронної пошти та ролі.
lastMessage Object Інформація про останнє повідомлення в чаті. Складається з унікального внутрішнього ідентифікатора повідомлення, тексту та дати створення. Якщо останнє повідомлення було надіслано від члена команди, об’єкт також міститиме ідентифікатор цього члена команди.
Ви можете використовувати chat id та customer id з будь-якої події чату, щоб за допомогою методів REST API "Отримати інформацію про чат" або "Отримати інформацію про контакт".
Чи була наша стаття корисною?