Dla: Administratorzy
Wyszukaj zdarzenia i ładunki webhook
Co wysyła każde z dziesięciu zdarzeń kanału, jak szyfrowana jest wiadomość i jak ją odszyfrować za pomocą swojego klucza tajnego.
W tym artykule4 sekcji
Na tej stronie znajduje się lista zdarzeń, które jest wysyłane za pomocą webhookaWebhook Adres, który podajesz centrali, aby mogła ona wysyłać do Twoich systemów wiadomości za każdym razem, gdy wpis w kanale lub komentarz ulegną zmianie.. Opisuje się również sposób dostarczania każdego z wiadomości oraz treść, którą zawierają po odczytaniu.
Wydarzenia
| Wydarzenie | Na ekranie | Wysłane kiedy | content utrzymuje |
|---|---|---|---|
add_post | Zostaje utworzony post. | Ktoś publikuje informacje na stronie zawierającej dane o danym przypadku. | new: tekst wiadomości |
modify_post | Post został zmieniony. | Tekst posta został zmieniony. | new: nowy tekst |
delete_post | Posta zostało usunięte. | Posta zostało usunięte. | old: jego tekst |
add_post_comment | Komentarz jest już przygotowany. | Ktoś komentuje jakieś posty. | new: tekst komentarza |
modify_post_comment | Komentarz został zmieniony. | Tekst komentarza został zmieniony. | new: nowy tekst |
delete_post_comment | Komentarz został usunięty. | Komentarz został usunięty. | old: jego tekst |
add_post_media | Post Media jest tworzone. | Plik zostaje dodany do wiadomości. | new: link do pliku |
delete_post_media | Dane związane z tym postem zostały usunięte. | Plik zostaje usunięty z danej wiadomości. | old: link do usuniętego pliku |
add_post_comment_media | Media używane do umieszczania komentarzy są tworzone w ten sposób. | Plik został dodany do komentarza. | new: link do pliku |
delete_post_comment_media | Media używana do wpisywania komentarzy została usunięta. | Plik zostaje usunięty z komentarza. | old: link do usuniętego pliku |
- W każdym przypadku, w którym tworzysz sprawę, przesyłasz je wszystkie, niezależnie od tego, kto dokonał zmiany: personel, klient, Assistent wirtualnyAsystent wirtualny Automatyczny członek zespołu, który publikuje wiadomości powitalne, meldunki i wpisy dotyczące etapów rozwoju firmy. Jego wpisy są oznaczone odznaką wirtualnego asystenta., klucz importowy czy API. Wydarzenia związane z postami lub komentarzami nadal pojawiają się po tym, jak autor sprawy opuścił tę sprawę.
- Usunięcie przypadku nie powoduje żadnych efektów, nawet nie pojawia się komunikat
delete_postdotyczący postów, których przypadek został usunięty. Po usunięciu przypadku, API wysyła odpowiedź 404. - Tylko wpisy i komentarze na wpisach powodują wystąpienie zdarzeń. Notatki, zadania, formularze, elektroniczne dokumenty, a także zmiany w prawach dostępu do danego wpisu nie powodują żadnych zdarzeń.
- Pojawia się wiadomość z plikami. W takiej wiadomości znajdują się
add_post, a po każdym pliku –add_post_media. - Link do pliku funkcjonuje przez 48 godzin. Po usunięciu pliku, link do niego również zostaje usunięty w ciągu kilku chwil. Dlatego link w okresie usunięcia pliku może nie funkcjonować.
- W tekście występuje informacja w postaci
<@, która oznacza identyfikator użytkownika danej osoby, a także>, np.<@cu-4f1c2a9e8b7d60>.
Dostawa
- Każda wiadomość jest przesyłana jako POST do adresu webhook. W obrębie tej wiadomości znajduje się plik JSON, który zawiera jeden pol, a mianowicie
payload: to szyfrowana wiadomość. - Każdy stan poniżej 400 w ciągu 10 sekund jest uważany za dostarczony.
- Przetworzenie danych, które nie udaje się do przepakowania, nie jest powtarzane. Dwa takie przypadki powodują zatrzymanie funkcji webhook. Zobacz Wyeliminuj problemy związane z funkcją webhook.
- Przesłanie może przybyć dwa razy, albo w nieprawidłowy sposób. Użyj eventu, identyfikatora elementu oraz
when, aby to pokazać.
{"payload": "eyJhbGciOiJSU0EtT0FFUCIsImVuYyI6IkExMjhDQkMtSFMyNTYifQ.…"}
Odszyfrowywanie
payload to dane w formie kompaktowej, szyfrowane za pomocą metod RSA-OAEP i A128CBC-HS256. Sekret webhooka stanowi odpowiadający klucz prywatny – jest to plik w formacie PEM, który zaczyna się od tekstu -----BEGIN PRIVATE KEY-----. Można użyć pobranego pliku lub sekretu kopiowanego w całości, wraz z bokami tekstu. Każda biblioteka typu JOSE może go rozwiązać.
Python, z biblioteki 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, z biblioteką 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));
}
Nie istnieje żadna osobna podpis. Twój hub nigdy nie pokazuje klucza, którym szyfruje wiadomości. Dlatego wiadomość, która może zostać odczytana za pomocą twojego sekretu, pochodzi z twojego huba. Natomiast wiadomość, która jest zmieniona w trakcie przesyłania, nie może zostać odczytana. Jeśli kilka hubów wysyła wiadomości do tej samej adresy, należy sprawdzić również who.host.host_id.
Wiadomość
Odszyfrowany tekst: 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}
}
| Pole | Co zawiera |
|---|---|
what.trigger.name | Wydarzenie, opisane powyżej |
what.content.new lub what.content.old | Tekst, lub link do pliku |
who.user_id | Kto napisał ten post lub komentarz? A jeśli ktoś inny zmienił lub usunął go zawartość… |
who.post.post_id | Pismo dotyczące wydarzeń związanych z danym momentem. |
who.comment.comment_id | Komentarz dotyczący wydarzeń związanych z komentarzami |
who.comment.post_id | Tekst komentarza jest umieszczony w tym miejscu. |
who.case.case_id | Sytuacja, którą rozwiązuje API |
who.case.case_ref_id | ID tag danego przypadku: Tag IDIdentyfikator tagu Trwała etykieta nadawana obudowie, np. rear-end-2026, wyświetlana również jako ID referencyjne i używana przy imporcie. |
who.role.role_id | Rola autora w tym przypadku to role::clients. Brak takiej informacji oznacza, że autor nie brał udziału w tym przypadku. |
who.host.host_id | Twój partner/partnerka |
when.datetime.datetime | Gdy to się stało, w UTC. |
Pozostałe pola służą wyłącznie potrzebom samego centrum komunikacyjnego; należy je ignorować.