Наразі ви можете підписатися лише на події чату, контактів і повідомлення. Усі події вебхуків містять однакові атрибути, перелічені нижче:
| Поле | Тип | Опис |
| event | String | Тип чату або події контакту |
| eventData | Object | Контейнер для даних, пов’язаних із подією |
| attempts | Integer | Кількість спроб цієї події |
| lastAttemptAt | Date (UNIX timestamp) | Остання спроба доставки події |
| createdAt | Date (UNIX timestamp) | Дата і час створення події |
| id | String | Унікальний ідентифікатор події, наданий HelpCrunch |
🙋 Події контактів
| Тип події | Опис |
| customer.new | До вашого облікового запису HelpCrunch додано новий контакт. |
| customer.email_updated | Електронну адресу контакту оновлено. Зміна на нульове значення вважається оновленням. |
| customer.tags_changed | Теги контакту змінені. Видалення всіх тегів вважається оновленням. |
| customer.unsubscribed | Контакт відписався від ваших електронних листів. |
| customer.subscribed | Контакт підписався на ваші листи. |
| customer.blocked | Контакт заблокований будь-яким із членів вашої команди. |
| customer.unblocked | Контакт розблокований будь-яким із членів вашої команди. |
| customer.deleted | Контакт видалено з вашого облікового запису HelpCrunch. |
Коли відбувається подія контакту, HelpCrunch надсилає запит HTTP до вказаної кінцевої точки. Ви можете отримати основну інформацію про контакт зі структури eventData в тілі запиту (ідентифікатор, ім’я, електронна адреса, ідентифікатор контакту, скасований підписку), а також усі ваші власні дані контакту.
Модель контакту для вебхуків
Приклад відповіді
{
"event": "customer.email_updated",
"eventData": {
"id": 8745474,
"name": "Paul",
"userId": "example_2924",
"email": "[email protected]",
"unsubscribed": false,
"customData": {
"Role": "admin",
"Plan": "Enterprise (Unlimited) $9999/mo",
"segment": "PotentialChurn_premium_seg1",
"Currency": "USD",
"Emails sent": 621,
"Trial end date": "2017-07-24 14:30:00",
"Became payer at": "2017-09-13 00:00:00",
"Registered date": "2017-07-10 14:30:00",
"Next payment date": "2020-09-01 00:40:00",
"Billing info added": true,
"Number of payments": 35,
"Subscription status": "active"
},
"tags": [
{
"id": 52661,
"name": "Lead"
},
{
"id": 64814,
"name": "Enterprise"
}
],
},
"attempts": 0,
"lastAttemptAt": 1606151791,
"createdAt": 1606151791,
"id": "9e7ef91a-6243-4637-b5d2-404b68841ee9"
}Об’єкт eventData для подій контакту
| Поле | Тип | Опис |
| event | String | Тип події |
| id | Integer | Унікальний внутрішній ідентифікатор контакту в системі HelpCrunch |
| name | String | Ім'я контакту |
| userId | String | Власний унікальний ідентифікатор контакту, який ви можете передати до HelpCrunch за допомогою автентифікації користувача |
| String | Електронна адреса контакту | |
| unsubscribed | Boolean | Статус підписки на електронну пошту контакту. Правда - відписався. Неправда - підписався. |
| customData | Array | Ваші власні дані контакту представлені у вигляді масиву. Кожен атрибут складається з імені/властивості та значення. |
| tags | Array | Масив об'єктів тегів. Кожен тег містить свій унікальний ідентифікатор та назву HelpCrunch. |
Щоб отримати всі доступні дані контакту, використовуйте ідентифікатор контакту з події та викликайте метод REST API "Отримати інформацію про контакт".
