Pour: Administrateurs
Rechercher les événements et les charges utiles des webhooks
Ce que chacun des dix événements de flux envoie, comment le message est chiffré et comment le déchiffrer avec votre secret.
Dans cet article4 sections
Cette page liste les événements que le webhookWebhook Une adresse que vous fournissez au hub afin qu'il puisse envoyer un message à vos propres systèmes chaque fois qu'une publication ou un commentaire est modifié. envoie, la manière dont chaque message arrive, et ce qu’il contient une fois déchiffré.
Événements
| Événement | À l'écran | Envoyé lorsque | content contient |
|---|---|---|---|
add_post | Le post a été créé. | Quelqu’un publie des informations concernant un cas donné dans le flux d’informations correspondant à ce cas. | new : Le texte de la publication. |
modify_post | L’article a été modifié. | Le texte d’une publication a été modifié. | new : Le nouveau texte |
delete_post | L’article a été supprimé. | Un post a été supprimé. | old : son texte |
add_post_comment | Le commentaire est créé. | Quelqu’un commente une publication. | new : Le texte du commentaire. |
modify_post_comment | Le texte du commentaire a été modifié. | Le texte du commentaire a été modifié. | new : Le nouveau texte |
delete_post_comment | Le commentaire a été supprimé. | Un commentaire a été supprimé. | old : son texte |
add_post_media | Le post media est créé. | Un fichier est ajouté à une publication. | new : un lien vers le fichier. |
delete_post_media | Le contenu correspondant a été supprimé. | Un fichier est retiré d’une publication. | old : un lien vers le fichier qui a été supprimé. |
add_post_comment_media | Le média pour la publication de commentaires est créé. | Un fichier est ajouté au commentaire. | new : un lien vers le fichier. |
delete_post_comment_media | Le média utilisé pour la publication des commentaires a été supprimé. | Un fichier est retiré d’un commentaire. | old : un lien vers le fichier qui a été supprimé. |
- Dans chaque cas que vous gérez, les informations sont envoyées par celui qui a apporté cette modification : le personnel, un client, l’assistant virtuelAssistant virtuel Un membre d'équipe automatisé qui publie des messages de bienvenue, des enregistrements et des publications pour l'entreprise ; ses publications portent un badge d'assistant virtuel., une clé d’importation ou une clé API. Les événements liés aux messages ou aux commentaires surviennent toujours après que leur auteur a quitté le cas en question.
- Supprimer un cas ne produit aucun effet, même pas rien du tout.
delete_postLorsque ces postes sont supprimés, leur existence disparaît également. Une fois que les postes ont été effacés, l’API renvoie une erreur 404 pour ce cas. - Seuls les messages et les commentaires sur des posts peuvent déclencher des événements. Les notes, les tâches, les formulaires, les signatures électroniques, ainsi que les événements et leurs commentaires ne déclenchent aucun événement. De même, toute modification concernant qui peut voir un post n’a aucun effet.
- Un poste contenant des fichiers envoie
add_post, puis unadd_post_mediapour chaque fichier. - Un lien de fichier fonctionne pendant 48 heures. Le fichier supprimé est également détruit peu après sa suppression. Par conséquent, le lien lié à ce fichier peut ne plus être accessible.
- La mention dans le texte s’écrit
<@; il s’agit de l’identifiant utilisateur de la personne concernée. Ensuite, on trouve>, par exemple<@cu-4f1c2a9e8b7d60>.
Livraison
- Chaque message est une requête envoyée à l’adresse du webhook. Le corps du message est de type JSON, et contient un seul champ :
payload: le message chiffré. - Tout statut inférieur à 400 en moins de 10 secondes est considéré comme un succès.
- Une livraison qui échoue n’est pas renvoyée à nouveau. Deux échecs consécutifs suffisent pour interrompre le fonctionnement du webhook. Veuillez consulter la section Correction du webhook qui ne fonctionne plus.
- Un message peut arriver deux fois, ou de manière déréglée. Utilisez l’événement, l’ID de l’élément et
whenpour indiquer cela.
{"payload": "eyJhbGciOiJSU0EtT0FFUCIsImVuYyI6IkExMjhDQkMtSFMyNTYifQ.…"}
Décryptage
payload est un JWE dans une forme compacte, chiffré avec les algorithmes RSA-OAEP et A128CBC-HS256. Le secret lié au webhook correspond au clé privée correspondante ; il s’agit d’un fichier PEM qui commence par -----BEGIN PRIVATE KEY-----. Vous pouvez utiliser le fichier téléchargé, ou bien le secret copié tel quel, y compris les lignes de décalage. Une bibliothèque JOSE peut décoder ce secret.
Python, avec 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, avec 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));
}
Il n’y a pas de signature distincte. Votre hub ne montre jamais la clé avec laquelle il crypte les messages. Par conséquent, un message qui peut être déchiffré à l’aide de votre secret provient bien de votre hub. En revanche, un message qui est changé en cours de transmission ne peut pas être déchiffré. Si plusieurs hubs envoient des messages vers le même adresse, il est également nécessaire de vérifier who.host.host_id.
Le message
Le texte déchiffré est : 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}
}
| Champ | Ce qu'il contient |
|---|---|
what.trigger.name | L’événement, d’après le tableau ci-dessus |
what.content.new ou what.content.old | Le texte, ou un lien vers le fichier. |
who.user_id | Qui a écrit ce post ou ce commentaire ? Et si quelqu’un d’autre l’a modifié ou supprimé par la suite… |
who.post.post_id | L’article concerne les événements qui se sont déroulés par la suite. |
who.comment.comment_id | Les commentaires, sur les événements liés aux commentaires. |
who.comment.post_id | Le post sur lequel le commentaire est posté |
who.case.case_id | Le cas, selon l’ID que l’API utilise. |
who.case.case_ref_id | L’identifiant de la tagID de l'étiquette Une étiquette permanente que vous attribuez à un boîtier, telle que rear-end-2026, également appelée ID de référence et utilisée dans les importations. du cas en question. |
who.role.role_id | Le rôle de l’auteur dans cette affaire est indiqué par role::clients. Ce rôle est manquant si l’auteur a quitté l’affaire. |
who.host.host_id | Votre partenaire |
when.datetime.datetime | Lorsque cela s’est produit, dans le temps UTC. |
Les autres champs sont destinés à l’utilisation du hub lui-même ; ignorez-les.