HilfezentrumIntegrationen

Für: Administratoren

Webhook-Ereignisse und Nutzdaten nachschlagen

Was jedes der zehn Feed-Ereignisse sendet, wie die Nachricht verschlüsselt wird und wie Sie sie mit Ihrem Geheimnis entschlüsseln können.

In diesem Artikel4 Abschnitte

Auf dieser Seite werden die Ereignisse aufgeführt, die durch den WebhookWebhook Eine Adresse, die Sie dem Hub geben, damit dieser Ihre eigenen Systeme benachrichtigen kann, sobald sich ein Feed-Beitrag oder ein Kommentar ändert. ausgelöst werden. Es wird außerdem beschrieben, wie jede Nachricht ankommt und was sie nach der Entschlüsselung enthält.

Veranstaltungen

EreignisAuf dem BildschirmGesendet, wenncontent enthält
add_postDer Beitrag wurde erstellt.Jemand postet etwas im Feed eines Falls.new: Der Text des Beitrags
modify_postDer Post wurde geändert.Der Text einer Nachricht wurde geändert.new: Der neue Text
delete_postDie Nachricht wurde gelöscht.Eine Nachricht wurde gelöscht.old: Der Text davon
add_post_commentDer Kommentar wird erstellt.Jemand kommentiert einen Beitrag.new: Der Text des Kommentars
modify_post_commentDer Kommentar wurde geändert.Der Text eines Kommentars wurde geändert.new: Der neue Text
delete_post_commentDer Kommentar wurde gelöscht.Eine Kommentar wurde gelöscht.old: Der Text davon
add_post_mediaDie „Post Media“ wird erstellt.Ein Datei wird zu einer Nachricht hinzugefügt.new: Ein Link zum Datei-Datein
delete_post_mediaDie entsprechende Nachricht wurde gelöscht.Ein Datei wird aus einer Post entfernt.old: Ein Link zum entfernten Datei.
add_post_comment_mediaDas Medium für Kommentare wird erstellt.Ein Datei wird zu einem Kommentar hinzugefügt.new: Ein Link zum Datei-Datein
delete_post_comment_mediaDer Kommentar wurde gelöscht.Ein Datei wird aus einem Kommentar entfernt.old: Ein Link zum entfernten Datei.
  • In jedem Fall, in dem Sie sich befinden, werden alle Informationen weitergeleitet – egal wer die Änderungen vorgenommen hat: Mitarbeiter, Kunden, der virtuelle AssistentVirtueller Assistent Ein automatisiertes Teammitglied, das Begrüßungsnachrichten, Check-ins und Statusmeldungen für das Unternehmen veröffentlicht; seine Beiträge sind mit einem Virtual Assistant-Abzeichen versehen., eine Import- oder API-Schlüssel. Die Ereignisse, die in Beiträgen oder Kommentaren auftreten, werden trotzdem erst dann angezeigt, wenn der Autor des Beitrags oder Kommentars den Fall verlassen hat.
  • Das Löschen eines Falls führt zu nichts – nicht einmal zu delete_post für die Beiträge, die durch das Löschen des Falls entfernt werden. Sobald ein Fall gelöscht wird, gibt die API eine Fehlermeldung mit der Codezeile 404 zurück.
  • Nur Beiträge und Kommentare zu Beiträgen führen zu Ereignissen. Notizen, Aufgaben, Formulare, elektronische Signatur sowie Ereignisse und deren Kommentare bringen nichts hervor. Ebenso wenig wie eine Änderung bezüglich der Personen, die einen Beitrag sehen dürfen.
  • Eine Nachricht mit Dateien sendet add_post – anschließend eine Nachricht für jede Datei, also insgesamt add_post_media Nachrichten pro Datei.
  • Ein Dateienlink ist für eine Dauer von 48 Stunden gültig. Die entfernte Datei wird jedoch kurz darauf gelöscht. Daher kann der Link im Zusammenhang mit einer Löschaktion nicht mehr angezeigt werden.
  • In dem Text wird die Person mit der Benutzer-ID <@ bezeichnet. Zudem wird auch die Person mit der ID > erwähnt – beispielsweise <@cu-4f1c2a9e8b7d60>.

Lieferung

  • Jedes Nachrichtensignal ist eine Anfrage an die Adresse des Webhooks. Der JSON-Body enthält ein Feld namens payload: das verschlüsselte Nachrichteninhalt.
  • Jeder Status, der unter 400 liegt, gilt als erfolgreich – und zwar innerhalb von 10 Sekunden.
  • Ein versagter Versand wird nicht erneut verschickt. Zwei solcher Fehler führen dazu, dass der Webhook nicht mehr funktioniert. Siehe dazu Beheben Sie den Webhook, der nicht mehr funktioniert.
  • Eine Nachricht kann zweimal ankommen – oder auch nicht ordnungsgemäß. Verwenden Sie dazu das Ereignis, die ID des Elements sowie when, um dies zu signalisieren.
{"payload": "eyJhbGciOiJSU0EtT0FFUCIsImVuYyI6IkExMjhDQkMtSFMyNTYifQ.…"}

Entschlüsselung

payload ist ein JWE in komprimiertem Format. Es wurde mit den Algorithmen RSA-OAEP und A128CBC-HS256 verschlüsselt. Das „Webhook“-Geheimnis entspricht dem passenden privaten Schlüssel – es handelt sich dabei um eine PEM-Datei, die mit -----BEGIN PRIVATE KEY----- beginnt. Verwenden Sie die heruntergeladene Datei oder das Geheimnis in seiner vollen Länge, einschließlich der Zeilenumbrüche. Jede JOSE-Bibliothek kann dieses Dokument entschlüsseln.

Python, mit 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, in Kombination mit 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));
}

Es gibt keine separaten Signatur. Ihr Hub zeigt nie die Schlüssel an, mit denen er verschlüsselt. Daher stammt eine Nachricht, die mit Ihrem Geheimnis entschlüsselt werden kann, von Ihrem Hub. Eine Nachricht, die auf dem Weg dorthin entschlüsselt wird, kann nicht entschlüsselt werden. Wenn mehrere Hubs Nachrichten an denselben Ort senden, sollten Sie auch who.host.host_id überprüfen.

Die Botschaft

Entschlüsseltes 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}
}
FeldWas es enthält
what.trigger.nameDie Veranstaltung, wie sie oben auf der Tabelle beschrieben wird.
what.content.new oder what.content.oldDer Text – oder ein Link zum Datei-Datei
who.user_idWer hat den Beitrag oder Kommentar geschrieben – und auch, wenn jemand anderes diesen Beitrag oder Kommentar später geändert oder gelöscht hat?
who.post.post_idDer Beitrag über Ereignisse, die nach dem Ereignis stattgefunden haben.
who.comment.comment_idDer Kommentar zu den Kommentarereignissen
who.comment.post_idWelcher Beitrag ist der Kommentar beigefügt?
who.case.case_idDer Fall wird durch die ID bestimmt, die von der API verwendet wird.
who.case.case_ref_idDer Tag-IDTag-ID Eine permanente Bezeichnung, die Sie einem Fall geben, z. B. rear-end-2026, die auch als Referenz-ID angezeigt und bei Importen verwendet wird. des Falles
who.role.role_idDie Rolle des Autors in dem Fall – also die Position von role::clients. Fehlt, wenn der Autor den Fall bereits verlassen hat.
who.host.host_idDein Zuhause
when.datetime.datetimeAls das geschah, war es im UTC-Zeitraum.

Die anderen Felder dienen ausschließlich dem eigenen Gebrauch des Knotens. Sie können ignoriert werden.

Verwandte Artikel

Richten Sie einen Webhook für die Feed-Aktivität ein.Sende deinem eigenen System eine Nachricht, sobald ein Feed-Beitrag, ein Kommentar oder ein Anhang hinzugefügt, geändert oder gelöscht wird.Integrationen · 10 minBeheben Sie einen Webhook, der keine Daten mehr sendet.Warum ein Webhook nach zwei fehlgeschlagenen Zustellungen oder bei Inaktivität stoppt und wie das erneute Speichern ihn wieder aktiviert.Integrationen