Lister les événements webhook par famille

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": "transfer.geo_blocked",
      "family": "transfer",
      "stability": "stable",
      "description": "Download blocked by geo policy.",
      "required_plan": "ultra"
    }
  ],
  "total": 17,
  "filter": {
    "family": "transfer"
  },
  "object": "list",
  "families": [
    {
      "count": 17,
      "family": "transfer"
    },
    {
      "count": 9,
      "family": "workspace"
    },
    {
      "count": 6,
      "family": "member"
    },
    {
      "count": 5,
      "family": "coffre"
    },
    {
      "count": 5,
      "family": "api_key"
    }
  ]
}

Cet endpoint expose le catalogue d'événements webhook de Coffrify. Il sert à découvrir quels types d'événements (par exemple transfer.created, coffre.accessed, member.invited) peuvent être souscrits sur un endpoint webhook. Sans paramètre, il renvoie l'intégralité du catalogue ; avec le paramètre family, il ne retourne que les événements de la famille demandée. Dans tous les cas, la réponse inclut un récapitulatif families listant chaque famille existante et son nombre d'événements, trié par décompte décroissant. Le catalogue est statique (source de vérité côté serveur) : aucune donnée propre au workspace n'est lue.

Comportement notable : un family inconnu ne produit pas d'erreur ; il renvoie simplement une liste data vide (total: 0), tout en conservant le récapitulatif complet families. C'est utile pour valider côté client qu'une famille existe avant de proposer un abonnement.

Authentification

Requête authentifiée par clé API valide via l'en-tête Authorization: Bearer cof_live_.... Le scope webhooks:read est requis. Une clé sans ce scope reçoit une erreur 403 scope_missing.

Paramètres de requête

Réponse

La réponse est un objet list (object: "list"). Le tableau data contient les entrées du catalogue filtrées ; chaque entrée porte type (identifiant de l'événement), family, description, stability (toujours "stable") et, le cas échéant, required_plan (free / pro / ultra / entreprise) lorsqu'un plan minimum est exigé pour recevoir l'événement. Le champ total indique le nombre d'éléments dans data. Le tableau families récapitule, indépendamment du filtre, chaque famille (family) et son nombre d'événements (count), trié par count décroissant. Enfin, filter.family reflète le filtre appliqué (null si aucun).

Erreurs

Voir aussi

• GET /v1/webhooks/events — catalogue complet des types d'événements (sans regroupement par famille).
• POST /v1/webhooks — créer un endpoint webhook et y abonner des types d'événements.
• POST /v1/webhooks/{id}/rotate-secret — faire pivoter le secret de signature d'un endpoint.