Coffrifydocs
⌘K
Webhooks

Catalogue des événements

Tous les types d'événements avec description et payload type.

Voici l'ensemble des événements que vous pouvez écouter. Spécifiez le sous-ensemble voulu lors de la création de votre webhook.

Transferts

  • **`transfer.created`** - Un transfert vient d'être créé (statut `pending_upload`).
  • **`transfer.completed`** - Les fichiers ont été uploadés et finalisés. Le lien est actif.
  • **`transfer.downloaded`** - Un destinataire a téléchargé au moins un fichier.
  • **`transfer.password_failed`** - Un destinataire a entré un mauvais mot de passe (3 tentatives).
  • **`transfer.expired`** - Le transfert a dépassé sa date d'expiration. Fichiers supprimés.
  • **`transfer.deleted`** - Le transfert a été supprimé manuellement via Dashboard ou API.

Clés API

  • **`api_key.created`** - Nouvelle clé API créée dans le workspace.
  • **`api_key.revoked`** - Clé API révoquée. Les requêtes en cours avec cette clé sont rejetées immédiatement.

Workspace

  • **`workspace.member_added`** - Un membre a été invité et a accepté.
  • **`workspace.member_removed`** - Un membre a été retiré.
  • **`workspace.plan_changed`** - Le plan du workspace a changé (upgrade ou downgrade).

Webhooks

  • **`webhook.disabled`** - Le webhook a été désactivé automatiquement après trop d'échecs consécutifs (> 20 en 24h).
Écouter tous les événements

Passez `"events": ["*"]` lors de la création du webhook pour recevoir tous les types actuels et futurs. Recommandé uniquement pour les endpoints de logging.

Exemple - transfer.completed

{
  "id":      "evt_01JXXXXXXXXXXXXXXXX",
  "type":    "transfer.completed",
  "created": 1716897600,
  "data": {
    "object": {
      "id":           "tr_01JXXXXXXXXXXXXXXXX",
      "short_code":   "X9aB2c",
      "share_url":    "https://r.coffrify.com/X9aB2c",
      "status":       "active",
      "file_count":   1,
      "total_size":   204800,
      "expires_at":   "2026-06-02T10:00:00Z",
      "workspace_id": "ws_01JXXXXXXXXXXXXXXXX"
    }
  }
}