Центр поддержкиИнтеграции

Для: Администраторы

Найдите информацию о событиях и полезных нагрузках веб-хуков.

Что отправляет каждое из десяти событий ленты, как шифруется сообщение и как его расшифровать с помощью вашего секретного ключа.

В этой статье4 разделов

На этой странице перечислены события, которые отправляется через webhookВебхук Адрес, который вы указываете центру управления, чтобы он мог отправлять сообщения вашим системам всякий раз, когда изменяется сообщение в ленте или комментарий.. Указано также, как каждое сообщение достигает цели, и что содержится в нем после расшифровки.

События

СобытиеНа экранеОтправлено, когдаcontent имеет
add_postОтчет создан.Кто-то публикует информацию о данном случае в разделе новостей.new: текст сообщения
modify_postПост был изменен.Текст поста был изменен.new: новый текст
delete_postПост удален.Отправленное сообщение удалено.old: его текст
add_post_commentКомментарий создан.Кто-то комментирует опубликованное сообщение.new: текст комментария
modify_post_commentКомментарий был изменен.Текст комментария был изменен.new: новый текст
delete_post_commentКомментарий удален.Комментарий удален.old: его текст
add_post_mediaСредства массовой информации создаются таким образом.К посту добавляется файл.new: ссылка на файл
delete_post_mediaСообщение было удалено.Файл удаляется из сообщения.old: ссылка на удаленный файл
add_post_comment_mediaСредства для отправки комментариев создаются.Файл добавляется в комментарий.new: ссылка на файл
delete_post_comment_mediaМедиа для размещения комментариев удалено.Файл удаляется из комментария.old: ссылка на удаленный файл
  • В каждом случае ваш центр отправляет информацию о том, кто произвел изменения: сотрудники, клиенты, Виртуальный помощникВиртуальный помощник Автоматизированный член команды, который публикует приветственные сообщения, проводит проверки и организует публикации для компании; его публикации отмечены значком виртуального помощника., либо ключ для импорта данных или API-ключ. События, связанные с постами или комментариями, все равно сохраняются после того, как автор этих сообщений/комментариев покидает дело.
  • Удаление дела не приводит ни к каким результатам, даже ничего не происходит. delete_post После удаления сообщений они исчезают. Как только сообщения удаляются, API возвращает ответ с кодом 404 в таких случаях.
  • События могут возникать только в результате публикации постов и комментариев к ним. Записи, задачи, формы, электронные документы, а также события и соответствующие им комментарии не способствуют возникновению событий. Также изменение права на просмотр поста также не влияет на возникновение событий.
  • Пост с файлами отправляется в виде add_post. Для каждого файла используется один элемент вида add_post_media.
  • Ссылка на файл действует в течение 48 часов. Файл, после чего удаляется, также удаляется сразу же после этого. Поэтому ссылка, указанная в сообщении об удалении файла, может не работать.
  • В тексте упоминается <@ – это идентификатор пользователя, а также >, например <@cu-4f1c2a9e8b7d60>.

Доставка

  • Каждое сообщение представляет собой запрос, отправляемый по адресу вебхука. В теле этого сообщения содержится один поле: payload: зашифрованное сообщение.
  • Любое значение статуса ниже 400 в течение 10 секунд считается успешным.
  • Если доставка не происходит, товар снова не отправляется. Два таких случая приводят к прекращению работы вебхука. См. раздел Устранение проблем с вебхуком, который перестал отправлять данные.
  • Сообщение может прийти дважды, или же оно может быть некорректным. Для обозначения таких случаев используйте элемент события, ID элемента и when.
{"payload": "eyJhbGciOiJSU0EtT0FFUCIsImVuYyI6IkExMjhDQkMtSFMyNTYifQ.…"}

Расшифровка

payload представляет собой JWE в компактном формате; данный файл зашифрован с использованием алгоритмов RSA-OAEP и A128CBC-HS256. Секрет для использования в webhook-сервисе представляет собой соответствующий частный ключ – это PEM-файл, начинающийся с символа -----BEGIN PRIVATE KEY-----. Можно использовать загруженный файл или секрет, скопированный целиком, включая все отступы в тексте. Любая библиотека JOSE может расшифровать этот файл.

Python, с использованием библиотеки jwcrypto:

import json
from jwcrypto import jwk, jwt

with open("webhook-private-key.pem", "rb") as f:
    key = jwk.JWK.from_pem(f.read())

def read_message(body):
    token = jwt.JWT(jwt=body["payload"], key=key, expected_type="JWE")
    return json.loads(token.claims)

Node.js, с использованием библиотеки jose:

import { readFileSync } from 'node:fs';
import { compactDecrypt, importPKCS8 } from 'jose';

const key = await importPKCS8(readFileSync('webhook-private-key.pem', 'utf8'), 'RSA-OAEP');

export async function readMessage(body) {
  const { plaintext } = await compactDecrypt(body.payload, key);
  return JSON.parse(new TextDecoder().decode(plaintext));
}

Не существует отдельного подписи. Ваш центральный узел никогда не указывает ключа, с помощью которого он шифрует сообщения. Следовательно, сообщение, которое можно расшифровать с использованием вашего секретного ключа, происходит от вашего центрального узла. Но если несколько узлов отправляют сообщения в один и тот же адрес, необходимо также проверить значение who.host.host_id.

Сообщение

Расшифрованный текст: add_post

{
  "who": {
    "user_id": "cu-4f1c2a9e8b7d60",
    "cc_owner": false,
    "post": {"post_id": "post::20261001140322_9f8e7d6c5b4a32"},
    "case": {"case_id": "cc-1a2b3c4d5e6f70", "case_ref_id": "rear-end-2026"},
    "role": {"role_id": "role::staff"},
    "host": {"host_id": "ca-7e6d5c4b3a2f10"}
  },
  "what": {
    "trigger": {"name": "add_post"},
    "content": {
      "new": "Hi Jane, your records request went out today.",
      "type": "app_add_post",
      "kwargs": {"case_id": "cc-1a2b3c4d5e6f70", "case_ref_id": "rear-end-2026"}
    }
  },
  "where": {"location": {"name": "app"}, "module": {"name": "post"}},
  "when": {"datetime": {"timezone": "utc", "datetime": "2026-10-01T14:03:22.123456+0000"}},
  "targets": {"user_ids": ["cu-4f1c2a9e8b7d60"], "cc_user_ids": [], "group_targets": false}
}
ПолеЧто в нём содержится
what.trigger.nameЭто событие, о котором говорится в таблице выше.
what.content.new или what.content.oldТекст или ссылка на файл
who.user_idКто написал этот пост или комментарий? Даже если кто-то другой внес изменения или удалил его.
who.post.post_idПост о происходящих событиях.
who.comment.comment_idКомментарии к событиям, связанным с комментариями
who.comment.post_idКомментарий был опубликован на этой странице.
who.case.case_idЭтот случай описывается с помощью ID, используемого в API.
who.case.case_ref_idID тегов данного случая: Tag IDИдентификатор метки Постоянная метка, которую вы присваиваете делу, например, rear-end-2026, также отображается в качестве идентификатора ссылки и используется при импорте.
who.role.role_idРоль автора в этом деле – это, например, role::clients. Эта информация отсутствует, если автор уже покинул это дело.
who.host.host_idВаш хаб
when.datetime.datetimeКогда это произошло, по времени UTC.

Остальные поля предназначены исключительно для использования самого узла; их можно игнорировать.

Статьи по теме

Настройте веб-хук для отслеживания активности в ленте новостей.Отправляйте вашей системе сообщение всякий раз, когда добавляется, изменяется или удаляется запись в ленте, комментарий или вложение.Интеграции · 10 minИсправлена ошибка в веб-хуке, из-за которой он перестал отправлять сообщения.Почему веб-хук останавливается после двух неудачных попыток доставки или когда он неактивен, и как его повторное сохранение активирует его снова.Интеграции