Lister les types d'événements webhook

Retourne le catalogue complet des types d'événements webhook supportés par Coffrify, avec leur famille, description et plan requis.

2 min de lectureTélécharger en PDF

Réponse exemple

{
  "data": [
    {
      "type": "transfer.created",
      "family": "transfer",
      "stability": "stable",
      "description": "A new transfer was created."
    },
    {
      "type": "transfer.scan_clean",
      "family": "transfer",
      "stability": "stable",
      "description": "Scan completed with no threats found.",
      "required_plan": "pro"
    },
    {
      "type": "coffre.created",
      "family": "coffre",
      "stability": "stable",
      "description": "A data room was created.",
      "required_plan": "pro"
    },
    {
      "type": "ping",
      "family": "system",
      "stability": "stable",
      "description": "Test event triggered manually."
    }
  ],
  "total": 79,
  "object": "list",
  "families": [
    "transfer",
    "workspace",
    "member",
    "api_key",
    "api_token",
    "webhook",
    "scim",
    "saml",
    "audit",
    "gdpr",
    "collection",
    "coffre",
    "request",
    "domain",
    "billing",
    "session",
    "rule",
    "system"
  ]
}

GET/v1/webhooks/eventsCatalogue des types d'événements webhook disponibles dans Coffrify.

Renvoie le catalogue de référence de tous les types d'événements webhook que Coffrify peut émettre. Chaque entrée décrit un type d'événement (par exemple transfer.created ou coffre.accessed), sa famille fonctionnelle, sa stabilité et, le cas échéant, le plan minimum requis pour le recevoir. Utilisez cet endpoint pour construire dynamiquement la liste des événements auxquels un endpoint webhook peut s'abonner, plutôt que de coder ces valeurs en dur. La réponse est mise en cache côté CDN pendant 300 secondes (Cache-Control: public, max-age=300).

Authentification

Aucune authentification requise. Cet endpoint est public : il n'attend ni clé API ni scope particulier, afin que les générateurs de documentation et les explorateurs curl puissent l'interroger librement. Les requêtes OPTIONS sont gérées en pré-vol CORS (Access-Control-Allow-Origin: *).

Paramètres de requête

Cet endpoint n'accepte aucun paramètre de requête. Il renvoie systématiquement l'intégralité du catalogue. Le filtrage par famille ou par plan doit être effectué côté client à partir du tableau data.

Réponse

Renvoie un objet de type liste (object: "list"). Le champ total donne le nombre de types d'événements, families liste les familles distinctes présentes dans le catalogue, et data contient le tableau des entrées du catalogue.

Champ	Type	Description
object	string	Toujours `"list"`.
total	number	Nombre total de types d'événements dans le catalogue.
families	string[]	Liste des familles distinctes (`transfer`, `workspace`, `coffre`, `system`, etc.).
data	object[]	Tableau des entrées du catalogue d'événements.
data[].type	string	Identifiant du type d'événement (ex. `transfer.downloaded`).
data[].family	string	Famille fonctionnelle de l'événement.
data[].description	string	Description courte de ce que déclenche l'événement.
data[].stability	string	Niveau de stabilité ; toujours `"stable"`.
data[].required_plan	string (optionnel)	Plan minimum requis (`free`, `pro`, `ultra` ou `entreprise`). Absent si l'événement est disponible sur tous les plans.

Erreurs

Cet endpoint est public et purement en lecture : en fonctionnement nominal il renvoie toujours 200 OK. Les codes ci-dessous relèvent de l'infrastructure plutôt que de la validation applicative.

Code	Quand	Résolution
200	Le catalogue a été renvoyé avec succès.	Aucune action requise.
405	Une méthode autre que `GET` ou `OPTIONS` est utilisée.	Utilisez `GET` pour lire le catalogue ; aucune écriture n'est possible sur cette route.

Voir aussi

POST /v1/webhooks : créer un endpoint webhook et s'abonner à des types d'événements de ce catalogue.
POST /v1/webhooks/{id}/rotate : faire tourner le secret de signature d'un endpoint webhook.
GET /v1/webhooks/{id}/deliveries : consulter l'historique des livraisons d'un endpoint.