WebHooks

Вебхуки API Radist.Online: как подписаться на события компании, формат уведомлений, типы event_type и настройка адреса доставки для подключений.

Общее

Swagger: https://api.radist.online/v2/docs#/Webhooks

Необходимые права доступа (scopes) для работы с API: webhooks

Для получения уведомлений о событиях, происходящих в компании, можно подписаться на вебхуки. Это рекомендуемый способ получения уведомлений.

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

Создание подписки

WebhooksCreateItem (POST /companies/{company_id}/webhooks/)

Для подписки на вебхуки необходимо задать адрес, на который они будут приходить, указать, для какого из подключений вы хотите получать вебхуки и указать список типов событий (event_type, описаны ниже), уведомления о которых вам нужны.

Пример подписки на вебхуки

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
POST /companies/{company_id}/webhooks/
{
  "url": "https://example.org/webhook",
  "connection_id": 6466,
  "events": ["messages.create", "connections.status_changed"]
}


Response
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "url": "https://example.org/webhook",
  "connection_id": 6466,
  "events": ["messages.create", "connections.status_changed"]
}

Список подписок

WebhooksListItems (GET /companies/{company_id}/webhooks/)

Возвращает список всех подписок на вебхуки компании.

Пример получения списка подписок

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
GET /companies/{company_id}/webhooks/

Response
[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "url": "https://example.org/webhook",
    "connection_id": 6466,
    "events": ["messages.create", "connections.status_changed"]
  }
]

Удаление подписки

WebhooksDeleteItem (DELETE /companies/{company_id}/webhooks/{webhook_id})

Пример удаления подписки

1
2
3
DELETE /companies/{company_id}/webhooks/3fa85f64-5717-4562-b3fc-2c963f66afa6

Response: 204 No Content

Формат вебхука

Общий формат такой:

1
2
3
4
5
{
  "company_id": 123,
  "event_type": "string",
  "event": {}
}

Содержимое event зависит от event_type:

event_type=messages.create:

1
2
3
4
5
6
{
  "connection_id": 12345,
  "contact_id": 12345 | null,
  "chat_id": "string",
  "message": {}
}

Поле contact_id приходит всегда, но может быть null — если у чата нет привязанного контакта.

Схема объекта message (см. модель Message): https://api.radist.online/v2/docs#/model-Message

event_type=messages.delivery.{delivered | read | error}:

1
2
3
4
5
6
7
8
{
  "connection_id": 12345,
  "contact_id": 12345 | null,
  "chat_id": "string",
  "message_id": "string",
  "error_type": "GENERIC_ERROR" | "SUBSCRIPTION_NOT_PAID" | "MESSENGER_USER_NOT_FOUND" | "DIALOGS_LIMIT_EXCEEDED" | "WABA_DIALOGS_LIMIT_EXCEEDED" | "CHAT_BLACKLISTED" | null,
  "error_text": "string" | null
}

event_type=connections.status_changed:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
// Возможные варианты:
// 1) status_type = good | bad
// 2) status_subtype = | normal (всё в порядке)
//                     | whatsapp_qr_not_scanned (только WhatsApp)
//                     | generic_authorization_error (ошибка авторизации)
//                     | generic_connection_error (прочие ошибки соединения)


// Первый логин, предыдущего статуса (old_status) нет
{
  "company_id": 12345,
  "event_type": "connections.status_changed",
  "event": {
    "connection_id": 4567,
    "new_status": {
      "status_type": "good",
      "status_subtype": "normal",
      "created_at": "2025-10-20T11:02:49.887235+00:00",
      "updated_at": "2025-10-20T11:02:49.887235+00:00"
    },
    "old_status": null
  }
}


// Соединение потеряно
{
  "company_id": 12345,
  "event_type": "connections.status_changed",
  "event": {
    "connection_id": 6789,
    "new_status": {
      "status_type": "bad",
      "status_subtype": "generic_authorization_error",
      "created_at": "2025-10-20T10:59:53.658191+00:00",
      "updated_at": "2025-10-20T10:59:53.635477+00:00"
    },
    "old_status": {
      "status_type": "good",
      "status_subtype": "normal",
      "created_at": "2025-10-20T09:47:04.765144+00:00",
      "updated_at": "2025-10-20T10:58:28.882972+00:00"
    }
  }
}

Замечания

Обрабатывайте вебхуки асинхронно. Сохранили в очередь, ответили, что приняли, и только потом обработали.
Уведомления одного подключения доставляются параллельно, поэтому порядок их получения не гарантируется. Уведомления по одному чату отправляются последовательно, и messages.create обычно приходит раньше уведомлений messages.delivery.{delivered | read | error} по тому же сообщению, но полагаться на это при обработке не стоит: повторная отправка после ошибки идёт отдельной очередью.
Тело ответа/заголовки ответа игнорируются. Рекомендуем сократить их до минимума.
На обновление настроек вебхуков может потребоваться до 5 минут. В течение этого времени вебхуки всё ещё могут приходить на ранее указанные адреса.
Сервер вебхуков ожидает ответ со статусами 200, 201, 202 в течение 5 секунд.
Если был получен ответ со статусом 4xx, то повторной отправки вебхука не будет.
Если был получен другой ответ, ответ был не получен за 5 секунд, или произошла другая ошибка (например, недействительный SSL-сертификат) то вебхук будет отправлен повторно с интервалами: 1, 3, 10, 30, 60 минут.
Если адрес подписки не резолвится (домена не существует или DNS не ответил), вебхук отбрасывается без повторной отправки.
Если адрес подписки несколько раз подряд не ответил (таймаут, ошибка соединения или SSL-сертификата, статус не из 200, 201, 202 и не 4xx), доставка на него приостанавливается. Пока она приостановлена, запросы на адрес не отправляются. Время от времени очередной вебхук отправляется как проверочный — как только адрес ответит, доставка возобновится. Пауза действует на адрес целиком, для всех подписок с этим URL.
Если сервер не отвечает или отвечает статусами 5xx дольше 3 часов подряд, отправка вебхуков может быть временно приостановлена или отключена совсем.

Примеры

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
// Текстовое сообщение (отправитель - пользователь с user_id=96)
{
  "company_id": 510,
  "event_type": "messages.create",
  "event": {
    "connection_id": 6466,
    "contact_id": 1183,
    "chat_id": 452764,
    "chat": {
      "id": 452764,
      "name": "A",
      "is_group": false,
      "phone": "79000000000",
      "username": null,
      "avatar_url": null
    },
    "message": {
      "message_id": "1a1937d6-bf4c-4269-b5a3-7a8c02c3aba2",
      "source_message_id": "false_79000000000@c.us_CD0E4C02A58334A581CDE1976E952A32",
      "chat_id": "79000000000@c.us",
      "direction": "inbound",
      "message_type": "text",
      "author": {
        "id": "0b4fadf0-76b1-4463-baae-e0c8a091263a",
        "name": "Dmitry V.",
        "external_id": "96",
        "user_id": 96,
        "phone": null
      },
      "created_at": "2024-02-07T13:28:05+00:00",
      "delivered_at": null,
      "read_at": null,
      "error_at": null,
      "text": {
        "text": "6"
      },
      "reply_to": {
        "source_message_id": "false_79000000000@c.us_CD0E4C02A58334A581CDE1976E952A20",
        "message_id": "d4cebd78-6d8c-471a-83a5-5ac9ecce6e5d"
      }
    }
  }
}


// Сообщение с файлом (с картинкой)
{
    "company_id": 510,
    "event_type": "messages.create",
    "event": {
        "connection_id": 6466,
        "contact_id": 1183,
        "chat_id": 452764,
        "chat": {
            "id": 452764,
            "name": "A",
            "is_group": false,
            "phone": "79000000000",
            "username": null,
            "avatar_url": null
        },
        "message": {
            "message_id": "0e476e42-014d-499b-9755-c60499884ec6",
            "source_message_id": "false_79000000000@c.us_06721C8DAA4798EB67A6F8943E273E87",
            "chat_id": "79000000000@c.us",
            "direction": "inbound",
            "message_type": "image",
            "author": null,
            "created_at": "2024-02-07T13:45:20+00:00",
            "delivered_at": null,
            "read_at": null,
            "error_at": null,
            "image": {
                "caption": "Demo",
                "name": "3a5891c7-5c8b-4793-9eff-9f77782e0c07.jpg",
                "size": 73065,
                "mime_type": "image/jpeg",
                "url": "https://example.org/image.jpg"
            },
            "reply_to": null
        }
    }
}


// Сообщение с корзиной waba
{
    "company_id": 12345,
    "event_type": "messages.create",
    "event": {
        "connection_id": 123123,
        "contact_id": 1,
        "chat_id": 186008,
        "chat": {
            "id": 186008,
            "name": "Demo",
            "is_group": false,
            "phone": "79000000000",
            "username": null,
            "avatar_url": "https://example.org/avatar.jpg"
        },
        "message": {
            "message_id": "3a830de8-5b5f-480d-a821-49e9b14f9a7e",
            "source_message_id": "ABGGeRclMZhPAhBMMpdb-YwGu6DPc-XuT08H",
            "chat_id": "79000000000",
            "direction": "inbound",
            "message_type": "waba_order",
            "created_at": "2023-08-25T10:09:53+00:00",
            "delivered_at": null,
            "read_at": null,
            "error_at": null,
            "waba_order": {
                "currency": "RUB",
                "amount": 6000,
                "items": [
                    {
                        "name": "WhatsApp + amoCRM",
                        "price": 3000,
                        "quantity": 1,
                        "image_url": "https://radist2.cdn.radist.online/facebook/products/241352448870357/4y7fbkr62n/image.jpg",
                        "retailer_id": "4y7fbkr62n"
                    },
                    {
                        "name": "Телегомагазин",
                        "price": 1500,
                        "quantity": 2,
                        "image_url": "https://radist2.cdn.radist.online/facebook/products/241352448870357/psgsvcmha7/image.jpg",
                        "retailer_id": "psgsvcmha7"
                    }
                ],
                "comment": "",
                "catalog_id": 241352448870357
            },
            "reply_to": null
        }
    }
}


// Сообщение в групповом чате (chat.is_group=true)
{
  "company_id": 510,
  "event_type": "messages.create",
  "event": {
    "connection_id": 6466,
    "contact_id": 1225,
    "chat_id": 452784,
    "chat": {
      "id": 452784,
      "name": "A",
      "is_group": true,
      "avatar_url": null
    },
    "message": {
      "message_id": "1b92db5f-0214-4641-b524-e5386a964800",
      "source_message_id": "false_120361213164524017@g.us_05CFE59C2F17C02ED9EC462A7E561DC3",
      "chat_id": "120363233164524017@g.us",
      "direction": "inbound",
      "message_type": "text",
      "author": {
        "id": "e6f74a69-c7a9-4b72-ae64-c2d6473b201a",
        "name": "A",
        "external_id": "79000000000@c.us",
        "phone": "+79000000000"
      },
      "created_at": "2024-02-07T13:29:23+00:00",
      "delivered_at": null,
      "read_at": null,
      "error_at": null,
      "text": {
        "text": "2"
      },
      "reply_to": null
    }
  }
}



// Сообщение доставлено
{
    "company_id": 12345,
    "event_type": "messages.delivery.delivered",
    "event": {
        "connection_id": 123123,
        "contact_id": 217140,
        "chat_id": 1036686,
        "message_id": "3fe648ad-fbb4-4412-9081-2ee31b02a164"
    }
}

// Сообщение прочитано
{
    "company_id": 12345,
    "event_type": "messages.delivery.read",
    "event": {
        "connection_id": 123123,
        "contact_id": 217140,
        "chat_id": 1036686,
        "message_id": "3fe648ad-fbb4-4412-9081-2ee31b02a164"
    }
}

// Ошибка доставки
{
  "company_id": 12345,
  "event_type": "messages.delivery.error",
  "event": {
    "connection_id": 123123,
    "contact_id": 217140,
    "chat_id": 1036686,
    "message_id": "3fe648ad-fbb4-4412-9081-2ee31b02a164",
    "error_type": "GENERIC_ERROR",
    "error_text": "Re-engagement message\nMessage failed to send because more than 24 hours have passed since the customer last replied to this number."
  }
}

Часто задаваемые вопросы

Почему вебхуки перестали приходить?

Скорее всего, доставка на ваш адрес приостановлена. Так происходит, если адрес несколько раз подряд не ответил: таймаут, ошибка соединения, недействительный SSL-сертификат или статус не из 200, 201, 202 и не 4xx. Пока доставка на паузе, запросы не отправляются, но время от времени уходит проверочный вебхук — как только адрес ответит, доставка возобновится сама. Пауза действует на URL целиком, то есть на все подписки с этим адресом. Если сервер не отвечает или отдаёт 5xx дольше трёх часов подряд, отправка может быть приостановлена или отключена совсем.

Сколько раз повторяется отправка, если сервер не ответил?

Пять раз, с нарастающими интервалами: через 1, 3, 10, 30 и 60 минут. Повторы включаются, если ответ не получен за 5 секунд, пришёл статус не из успешных или произошла другая ошибка вроде недействительного сертификата. Исключение одно: если адрес подписки не резолвится — домена не существует или не ответил DNS — вебхук отбрасывается сразу, без повторов.

Какой ответ должен возвращать мой сервер?

Статус 200, 201 или 202, и уложиться нужно в 5 секунд. Тело ответа и заголовки игнорируются, так что их лучше сократить до минимума. Отсюда же главная рекомендация по обработке: принимать вебхук асинхронно — положить в очередь, сразу ответить, что приняли, и разбирать уже после.

Поменял адрес подписки, а вебхуки идут на старый

Это нормально в первые минуты: на обновление настроек может потребоваться до 5 минут, и всё это время вебхуки ещё могут приходить на ранее указанный адрес. Если прошло больше, проверьте, что подписка действительно обновилась — через список подписок.

В каком порядке приходят вебхуки?

Порядок не гарантируется: уведомления одного подключения доставляются параллельно. По одному чату они отправляются последовательно, и messages.create обычно приходит раньше, чем messages.delivery по тому же сообщению, но строить обработку на этом не стоит — повторная отправка после ошибки идёт отдельной очередью и может прийти позже остальных.

Что будет, если ответить статусом 4xx?

Повторной отправки не будет: вебхук считается доставленным и больше не придёт. Поэтому 4xx стоит отдавать только осознанно — например, когда запрос действительно адресован не туда. Если обработчик временно не может принять данные, лучше вернуть 5xx или не ответить: тогда вебхук повторится по расписанию.

Помогла ли статья?

Последнее обновление 12 октября 2026 г.

Продажи WABA