Les événements Webhook et leur contenu

Chaque événement webhook Notiondesk que vous pouvez sélectionner, le format de requête que votre serveur reçoit et les données contenues pour chaque événement.

9 minutes de lecture

Chaque requête webhook vous informe des événements survenus dans votre espace de travail ou l'un de ses centres d'aide. Cet article répertorie tous les événements possibles pour un point de terminaison, décrit la structure et le contenu de chaque requête.

Accès rapide : Sélectionnez les événements dans Paramètres > Développeurs > Webhooks , sous Événements sur un point de terminaison. Chaque requête est un JSON contenant , , , , et .POSTideventversionoccurred_atsite_iddata

Événements que vous pouvez choisir

Le tableau de bord regroupe les événements de la même manière que les tableaux ci-dessous. La première colonne correspond au nom affiché dans le sélecteur d'événements. La seconde correspond au nom de l'événement reçu par votre serveur dans event.

Contacts

Dans le tableau de bord Événement Envoyé lorsque
Message de contact reçu Un visiteur vous envoie votre formulaire de contactcontact_message.created

Contenu

Dans le tableau de bord Événement Envoyé lorsque
Article créé Un nouvel article, ou une nouvelle langue d'un article, est ajouté.article.created
Article mis à jour Le contenu d'un article change lors d'une synchronisationarticle.updated
Article publié La langue d'un article est publiéearticle.published
Article non publié La langue publiée d'un article n'est plus publiée.article.unpublished
Article supprimé Un article a été supprimé.article.deleted
Article traduit Un article est traduit automatiquement dans une nouvelle languearticle.translated
Réaction ajoutée Un lecteur réagit à un articlearticle.reaction.added
La réaction a changé Un lecteur change d'avisarticle.reaction.changed
Réaction supprimée Un lecteur supprime sa réactionarticle.reaction.removed
Commentaires reçus sur l'article Un lecteur envoie un commentaire écrit sur un articlearticle.feedback.created
Catégorie créée Une nouvelle catégorie, ou une nouvelle langue d'une catégorie, est ajoutéecategory.created
Catégorie mise à jour Le contenu d'une catégorie change lors d'une synchronisationcategory.updated
Catégorie supprimée Une catégorie a été supprimée.category.deleted
Entrée du journal des modifications publiée Un article de la catégorie « Journal des modifications » est publié.changelog.published
Synchronisation terminée Une synchronisation avec Notion est terminéesync.completed
La synchronisation a échoué La synchronisation avec Notion a échoué.sync.failed

Les messages article.updated et category.updated ne sont pas envoyés lorsque seul le statut ou d'autres propriétés changent. Les événements de catégorie sont envoyés une fois par langue.

Les réactions et les commentaires sur les articles sont limités à 120 événements par minute pour chaque centre d'aide. Les événements dépassant cette limite ne sont pas envoyés ; veuillez donc consulter les statistiques de votre centre d'aide pour obtenir le total.

Paramètres du centre d'aide

Dans le tableau de bord Événement Envoyé lorsque
Paramètres du centre d'aide enregistrés Un paramètre du centre d'aide est enregistrésite.updated
Code personnalisé enregistré Les fichiers CSS ou JavaScript personnalisés sont enregistrés.site.custom_code.updated
Domaine personnalisé vérifié Votre domaine personnalisé commence à héberger le centre d'aide.site.domain.verified
La vérification du domaine personnalisé a échoué Impossible d'atteindre votre domaine personnalisésite.domain.verification_failed
Intégration mise à jour Une intégration est configurée, modifiée, activée ou désactivée.integration.updated
Notion connectée Notion est connecténotion.connected
Notion déconnectée Notion est déconnecténotion.disconnected
Accès à la notion perdu Notiondesk ne peut plus lire vos pages Notionnotion.access_lost
chatbot IA mis à jour Les paramètres du chatbot changent, ou il est activé ou désactivé.chatbot.updated
Ajout de conseils pour le chatbot Un guide a été ajouté au chatbot.chatbot.guidance.created
Mise à jour des directives relatives aux chatbots Les directives changentchatbot.guidance.updated
Les instructions du chatbot ont été supprimées. Une directive est suppriméechatbot.guidance.deleted
Redirection ajoutée Une redirection est ajoutéeredirect.created
Redirection mise à jour Une redirection changeredirect.updated
Redirection supprimée Une redirection a été supprimée.redirect.deleted

Les domaines personnalisés sont vérifiés régulièrement, les événements liés aux domaines peuvent donc apparaître quelques minutes après la modification.

Espace de travail

Les événements de l'espace de travail ne sont pas liés à un seul centre d'aide, donc leur site_id est null.

Dans le tableau de bord Événement Envoyé lorsque
Espace de travail renommé L'espace de travail est renomméworkspace.updated
Demande d'adhésion reçue Quelqu'un demande à rejoindre l'espace de travailworkspace.join_request.created
Demande d'adhésion approuvée La demande d'adhésion a été approuvée.workspace.join_request.approved
Demande d'adhésion refusée La demande d'adhésion a été refusée.workspace.join_request.declined
Coéquipier invité Un coéquipier est invitéteam_member.invited
Mon coéquipier a rejoint Un coéquipier invité accepteteam_member.joined
Le rôle du coéquipier a changé Le rôle d'un coéquipier changeteam_member.role_changed
Coéquipier activé ou désactivé Un coéquipier est activé ou désactivéteam_member.status_changed
Coéquipier retiré Un coéquipier est retiréteam_member.removed
Un coéquipier s'est connecté Un coéquipier se connecte. Envoyé uniquement à l'espace de travail qu'il ouvre par défaut.team_member.logged_in
Clé API créée Une clé API est créée.api_key.created
Clé API renouvelée Une clé API est renouveléeapi_key.rotated
Clé API révoquée Une clé API a été révoquée.api_key.revoked
Centre d'aide créé Un centre d'aide est créé.site.created
Centre d'aide supprimé Un centre d'aide est supprimé alors que l'espace de travail dispose toujours d'un autre centre d'aide en ligne.site.deleted

Événement de test

Dans le tableau de bord Événement Envoyé lorsque
Événement de test Vous cliquez sur Envoyer un événement de test sur un point de terminaisonping

Vous ne pouvez pas sélectionner ping dans la liste des événements. Cette requête est envoyée uniquement au point de terminaison que vous testez, son site_id est null, et elle est envoyée une seule fois, sans nouvelle tentative.

Contenu de chaque requête

Notiondesk envoie une requête POST avec un corps JSON :

{
  "id": "019a8f2e-4b1c-7d3e-9f40-5a6b7c8d9e01",
  "event": "article.published",
  "version": "2026-11-06",
  "occurred_at": "2026-11-17T14:32:05+00:00",
  "site_id": "019a8f2e-0b7d-7c3a-9e15-4f2a6b8c0d11",
  "data": {
    "article": {
      "id": "1763391842",
      "locale": "en",
      "title": "Reset your password",
      "slug": "reset-your-password",
      "url": "https://help.acme-support.com/en/articles/reset-your-password",
      "status": "published"
    }
  }
}
Champ Qu'est-ce que c'est
idL'identifiant de l'événement. Il reste inchangé lors d'une nouvelle tentative de requête ; utilisez-le donc pour repérer les doublons.
eventLe nom de l'événement, par exemple article.published
versionLa version de ce format de requête
occurred_atLorsque l'événement s'est produit, sous la forme d'une date et d'une heure ISO 8601
site_idLe centre d'aide d'où provient l'événement, ou null pour les événements d'espace de travail et l'événement de test
dataLe sujet de l'événement. Voir Contenu des données

Chaque requête comporte également ces en-têtes :

En-tête Valeur
Content-Typeapplication/json
User-AgentND-Webhooks/1.0
X-ND-EventLe nom de l'événement est identique à event dans le corps.
X-ND-DeliveryL'identifiant de cette livraison à ce point de terminaison. Il reste le même d'une tentative à l'autre.
X-ND-SignatureLa signature qui prouve que la requête provient de Notiondesk. Sa vérification est décrite dans la section « Vérifier qu'un webhook provient de Notiondesk ».

Quelles données contiennent

data contient un ou plusieurs objets, selon l'événement :

Événement Que contient data
contact_message.createdcontact_message: id, name, email, subject, message, locale
article.created, article.updated, article.published, article.unpublished, changelog.published article: id, locale, title, slug, url, status
article.translatedarticle dans la nouvelle langue, et source_locale
article.deletedarticle: id
article.reaction.added, article.reaction.changed, article.reaction.removed article: id, et reaction: type
article.feedback.createdarticle: id, et feedback: id, name, email, message, locale
category.created, category.updated category: id, locale, name, slug
category.deletedcategory: id
sync.completedsync: trigger, duration_seconds, pages_synced, pages_updated
sync.failedsync: reason, pages_processed
site.updated, site.created site: id, name, url
site.deletedsite: id
site.custom_code.updatedcustom_code: type (css ou js)
site.domain.verified, site.domain.verification_failed domain: name
integration.updatedintegration: type, enabled
notion.connected, notion.disconnected, notion.access_lost Un objet vide, {}
chatbot.updatedchatbot: id, name, enabled
chatbot.guidance.created, chatbot.guidance.updated guidance: id, type, title, enabled
chatbot.guidance.deletedguidance: id
redirect.created, redirect.updated redirect: id, source_path, type, article_id, category_id
redirect.deletedredirect: id
workspace.updatedworkspace: id, name
workspace.join_request.created, .approved, .declined join_request: id, email, status
team_member.invited, .joined, .role_changed, .status_changed team_member: id, email, role, status
team_member.removedteam_member: id
team_member.logged_inuser: id, email, name
__PRÉSERVÉ_77__, __PRÉSERVÉ_76__ api_key: id, prefix, label, scopes, expires_at
api_key.rotatedapi_key pour la nouvelle clé, et previous_api_key: id
pingmessage

data ne contient jamais de pièces jointes, de secrets, de code personnalisé ou de détails de facturation.

Exemple de données par famille d'événements

Ces exemples ne montrent que data. Le reste de la requête est identique pour chaque événement.

Formulaire de contact, contact_message.created:

Articles, article.translated:

status indique le statut de cette langue : draft, review, published, archived ou translation source. url peut être null si le centre d’aide n’a pas encore d’adresse.

Réactions et commentaires, article.feedback.created:

Pour les réactions, reaction.type correspond à smiley, neutral_face ou disappointed. Les centres d'aide affichant des boutons « J'aime » envoient smiley pour « Oui » et disappointed pour « Non ». Concernant les commentaires, article.id correspond à null lorsque l'article n'existe plus.

Catégories, category.created:

Synchronisations, sync.completed et sync.failed :

trigger est manual, api ou automatic. reason est pages_failed lorsque certaines pages n'ont pas pu être synchronisées, ou failed lorsque la synchronisation s'est arrêtée.

Paramètres du centre d'aide, redirect.created :

Espace de travail et coéquipiers, team_member.role_changed:

role est admin, editor, billing_manager ou viewer. status est enabled, disabled ou pending_invite.

Clés API, api_key.rotated:

Événement de test, ping:

Gérez les événements dans votre récepteur

{
  "contact_message": {
    "id": "019a8f31-5c2e-7a41-8b9d-2e6f0a7c4b23",
    "name": "Jamie Rivera",
    "email": "[email protected]",
    "subject": "Invoice question",
    "message": "Hi, where can I download my latest invoice?",
    "locale": "en"
  }
}
{
  "article": {
    "id": "1763391842",
    "locale": "fr",
    "title": "Réinitialiser votre mot de passe",
    "slug": "reinitialiser-votre-mot-de-passe",
    "url": "https://help.acme-support.com/fr/articles/reinitialiser-votre-mot-de-passe",
    "status": "published"
  },
  "source_locale": "en"
}
{
  "article": { "id": "1763391842" },
  "feedback": {
    "id": "019a8f33-8d4f-7b52-a1c3-6e9b2d0f7a35",
    "name": "Sam Lee",
    "email": "[email protected]",
    "message": "The screenshots don't match the new settings page.",
    "locale": "en"
  }
}
{
  "category": {
    "id": "1763392017",
    "locale": "en",
    "name": "Billing",
    "slug": "billing"
  }
}
{
  "sync": {
    "trigger": "automatic",
    "duration_seconds": 42,
    "pages_synced": 120,
    "pages_updated": 3
  }
}
{
  "sync": {
    "reason": "pages_failed",
    "pages_processed": 118
  }
}
{
  "redirect": {
    "id": "019a8f35-2a6c-7d63-b4e8-0c1f5a9d3e47",
    "source_path": "/old-help/reset-password",
    "type": "article",
    "article_id": "1763391842",
    "category_id": null
  }
}
{
  "team_member": {
    "id": "019a8f37-7e1b-7f74-8c2d-9a4e6b1f0c59",
    "email": "[email protected]",
    "role": "editor",
    "status": "enabled"
  }
}
{
  "api_key": {
    "id": "019a8f39-3f8a-7185-9d6e-1b7c4e2a8d6b",
    "prefix": "nd_wsk_4fa9c2e17b30",
    "label": "CRM sync",
    "scopes": ["read"],
    "expires_at": null
  },
  "previous_api_key": { "id": "0199c4d2-6b3e-7296-ae0f-5d8a1c7e9b7d" }
}
{
  "message": "Test event from Notiondesk."
}
  • Répondez rapidement. Retournez d'abord le code d'état 2xx, puis effectuez l'opération. Notiondesk attend 5 secondes que votre serveur commence à répondre (10 secondes au total) et ne lit que le code d'état.
  • Attendez-vous à des doublons. Un même événement peut survenir plusieurs fois, par exemple après une nouvelle tentative. Ignorez tout événement id déjà traité.
  • Ne vous fiez pas à l'ordre. Les événements peuvent survenir dans le désordre. Utilisez occurred_at lorsque l'ordre est important.
  • Les données sont lues comme étant dans leur état le plus récent. La valeur data est lue lors de l'envoi de l'événement ; ainsi, deux modifications rapides d'un article peuvent toutes deux inclure la version la plus récente. Si l'élément a disparu entre-temps, l'événement est ignoré.

Questions fréquentes

Est-ce que j'aurai accès à l'intégralité du contenu de l'article ?

Non. Les événements d'article contiennent le titre, le slug, l'URL et le statut. Utilisez l'API Notiondesk si vous avez besoin de plus d'informations.

Comment puis-je savoir de quel centre d'aide provient un événement ?

Lisez site_id. Il s'agit de l'identifiant du centre d'aide, ou null pour les événements d'espace de travail et l'événement de test.

Pourquoi n'ai-je pas reçu un événement pour chaque réaction ?

Les réactions et les commentaires sur les articles sont limités à 120 événements par minute et par centre d'aide. Les événements dépassant cette limite ne sont pas envoyés. Consultez les statistiques de votre centre d'aide pour obtenir le total.

Puis-je recevoir deux fois le même événement ?

Oui, par exemple après une nouvelle tentative. La variable id reste inchangée ; ignorez donc celle que vous avez déjà traitée.

Que signifie « version » ?

Il vous indique le format de requête utilisé. Les requêtes utilisent actuellement le format 2026-11-06.

Articles associés

Cette page a-t-elle été utile ?

Encore besoin d'aide ? Écrivez-nous