Lister le catalogue d'événements webhook

Retourne le catalogue complet des types d'événements webhook supportés par Coffrify, groupés par famille.

Réponse exemple

{
  "events": [
    {
      "type": "transfer.created",
      "family": "transfer",
      "stability": "stable",
      "description": "A new transfer was created."
    },
    {
      "type": "transfer.scan_infected",
      "family": "transfer",
      "stability": "stable",
      "description": "Scan detected malware. Files quarantined.",
      "required_plan": "pro"
    },
    {
      "type": "workspace.sso_configured",
      "family": "workspace",
      "stability": "stable",
      "description": "SSO/SAML configuration was added or updated.",
      "required_plan": "entreprise"
    },
    {
      "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."
    }
  ]
}

GET/v1/webhooks/event-catalogRetourne la liste complète des types d'événements webhook que Coffrify peut émettre.

Cet endpoint expose le catalogue d'événements webhook de Coffrify : la source de vérité de tous les types d'événements (type) auxquels un endpoint webhook peut s'abonner. Le catalogue couvre 74 événements répartis en 18 familles (transfert, workspace, membre, clé API, jeton API, webhook, SCIM, SAML, audit, RGPD, collection, coffre, demande, domaine, facturation, session, règle et système). La réponse est volontairement plate et stable : elle alimente la modal de création de webhook et le bloc catalogue de l'interface, mais peut tout aussi bien servir à valider côté client les types souscrits ou à générer une documentation à jour.

Authentification

Aucun scope spécifique n'est requis. Le handler ne lit ni en-tête Authorization ni clé API : le catalogue d'événements est une donnée publique et statique. Vous pouvez donc l'appeler sans authentification pour découvrir les types d'événements disponibles.

Paramètres de requête

Cet endpoint n'accepte aucun paramètre de requête. Tout filtrage (par famille, par plan requis, etc.) est à réaliser côté client sur le tableau events retourné.

Réponse

La réponse est un objet JSON contenant une seule clé events, un tableau d'entrées de catalogue. Chaque entrée décrit un type d'événement et ses métadonnées.

Champ	Type	Toujours présent	Description
type	string	oui	Identifiant unique de l'événement, au format `famille.action` (ex. `transfer.created`, `coffre.accessed`). Valeur à utiliser lors de la souscription d'un webhook.
family	string	oui	Famille de l'événement. Valeurs possibles : `transfer`, `workspace`, `member`, `api_key`, `api_token`, `webhook`, `scim`, `saml`, `audit`, `gdpr`, `system`, `collection`, `coffre`, `request`, `domain`, `billing`, `session`, `rule`.
stability	string	oui	Niveau de stabilité de l'événement. Actuellement toujours `stable`.
description	string	oui	Description courte (en anglais) de la condition qui déclenche l'événement.
required_plan	string	non	Plan minimum requis pour émettre cet événement, quand applicable : `free`, `pro`, `ultra` ou `entreprise`. Absent pour les événements disponibles sur tous les plans.

Erreurs

Code	Quand	Résolution
200 OK	Cas nominal : le catalogue est retourné.	Aucune action requise.
405 Method Not Allowed	Une méthode autre que GET est utilisée (seul GET est implémenté).	Utilisez la méthode GET.
500 Internal Server Error	Erreur serveur inattendue lors de la sérialisation du catalogue.	Réessayez ultérieurement ; si le problème persiste, contactez le support.

Voir aussi

POST /v1/webhooks : créer un endpoint webhook abonné à une liste de types d'événements issus de ce catalogue.
GET /v1/webhooks : lister les endpoints webhook existants et les événements auxquels ils sont abonnés.
POST /v1/webhooks/{id}/test : émettre un événement ping de test vers un endpoint pour valider sa configuration.