Se connecterCommencer gratuitement
Référence APILister les livraisons d'un webhook
GET/v1/webhooks/{id}/deliveries

Lister les livraisons d'un webhook

Récupère l'historique paginé des tentatives de livraison d'un endpoint webhook, de la plus récente à la plus ancienne.

2 min de lectureTélécharger en PDF

Réponse exemple

{
  "data": [
    {
      "id": "whd_3f2a1c8e9b4d",
      "status": "succeeded",
      "event_id": "evt_8c1d4a2f7e90",
      "created_at": "2026-06-05T09:14:22.480Z",
      "event_type": "transfer.completed",
      "duration_ms": 184,
      "status_code": 200,
      "attempted_at": "2026-06-05T09:14:22.512Z",
      "completed_at": "2026-06-05T09:14:22.696Z",
      "max_attempts": 5,
      "error_message": null,
      "next_retry_at": null,
      "attempt_number": 1
    },
    {
      "id": "whd_2b9e7d1a6c33",
      "status": "failed",
      "event_id": "evt_5a0b3c9d2f18",
      "created_at": "2026-06-05T08:47:10.060Z",
      "event_type": "dataroom.viewer.added",
      "duration_ms": 4021,
      "status_code": 503,
      "attempted_at": "2026-06-05T08:47:10.100Z",
      "completed_at": "2026-06-05T08:47:14.121Z",
      "max_attempts": 5,
      "error_message": "Upstream returned 503 Service Unavailable",
      "next_retry_at": "2026-06-05T09:17:14.121Z",
      "attempt_number": 2
    }
  ],
  "total": 137,
  "object": "list",
  "has_more": true
}
GET/v1/webhooks/{id}/deliveriesListe les tentatives de livraison passées pour un webhook donné.

Cet endpoint renvoie l'historique des tentatives de livraison (succès comme échecs) d'un endpoint webhook identifié par {id}. Chaque ligne correspond à une tentative de transmission d'un évènement vers l'URL configurée, incluant les ré-essais automatiques. Les résultats sont triés par date de création décroissante (la tentative la plus récente en premier) et la collection est paginée. Le webhook doit appartenir au workspace associé à la clé API : un identifiant inconnu ou rattaché à un autre workspace renvoie une erreur 404.

Authentification

Requiert une clé API valide portant le scope webhooks:read. La clé doit être transmise via l'en-tête Authorization: Bearer cof_live_... (ou cof_test_..., cof_rk_..., cof_mcp_...). Une clé sans ce scope reçoit une erreur 403 scope_missing. Le workspace est résolu à partir de la clé : seuls les webhooks de ce workspace sont visibles.

Paramètres de requête

ParamètreTypeRequisDescription
limitintegerNonNombre maximal de livraisons retournées. Défaut 50, plafonné à 100 (toute valeur supérieure est ramenée à 100).
offsetintegerNonDécalage de pagination (nombre de lignes à sauter). Défaut 0.

Le paramètre de chemin {id} est l'identifiant du webhook dont on veut consulter les livraisons.

Réponse

Réponse 200 enveloppée façon collection : object vaut "list", data est le tableau des livraisons, total donne le compte exact de toutes les livraisons du webhook (indépendamment de la pagination) et has_more indique s'il reste des pages au-delà de l'offset courant.

Chaque élément de data expose les champs : id, event_id, event_type, attempt_number, max_attempts, status, status_code (code HTTP renvoyé par l'endpoint cible), duration_ms, error_message (renseigné en cas d'échec), attempted_at, completed_at, next_retry_at (date du prochain ré-essai planifié, le cas échéant) et created_at.

Erreurs

CodeQuandRésolution
401 missing_api_keyEn-tête Authorization absent.Ajouter Authorization: Bearer cof_live_....
401 invalid_api_keyClé API invalide, mal formée ou introuvable.Vérifier la clé et son préfixe (cof_live_, cof_test_, cof_rk_..., cof_mcp_...).
403 scope_missingLa clé ne porte pas le scope webhooks:read.Émettre ou réémettre une clé incluant webhooks:read.
404 not_foundWebhook {id} inexistant ou hors du workspace de la clé.Vérifier l'identifiant via la liste des webhooks du workspace.
429 rate_limitedQuota de requêtes du workspace dépassé.Respecter l'en-tête Retry-After et lisser les appels.
500 internal_errorErreur interne lors de la lecture des livraisons.Réessayer ; persister avec le request_id à l'appui.

Voir aussi