Lister les livraisons d’un point de terminaison

GET/v1/webhook-endpoints/{webhookEndpoint}/deliveries

Droit de clé restreinte : webhooks:read.

Paramètres de chemin

webhookEndpointtexteobligatoire
L'identifiant, we_….

Paramètres de requête

limitentier
Le nombre d'objets rendus, de 1 à 100. Par défaut, 25.
starting_aftertexte
Un identifiant : la page qui suit cet objet.
ending_beforetexte
Un identifiant : la page qui précède cet objet.

Réponse

Rend le corps ci-contre.

Une erreur suit le format commun.

Requête

curl


curl https://api.ophelix.fr/v1/webhook-endpoints/we_…/deliveries?limit=3 \
  -H "Authorization: Bearer sk_test_…"

PHP


$client = new GuzzleHttp\Client(['base_uri' => 'https://api.ophelix.fr']);
 
$response = $client->get('/v1/webhook-endpoints/we_…/deliveries?limit=3', [
    'headers' => ['Authorization' => 'Bearer sk_test_…'],
]);
$object = json_decode((string) $response->getBody(), true);

TypeScript


const response = await fetch('https://api.ophelix.fr/v1/webhook-endpoints/we_…/deliveries?limit=3', {
  headers: { Authorization: 'Bearer sk_test_…' },
})
const object = await response.json()

Réponse 200


{
  "object": "list",
  "url": "/v1/webhook-endpoints/we_034t7hBCW2rOZqFLSge7q0/deliveries",
  "has_more": false,
  "data": [
    {
      "id": "whd_034t7hC5gptNkWM9wGgo2i",
      "object": "webhook_delivery",
      "status": "pending",
      "endpoint": "we_034t7hBCW2rOZqFLSge7q0",
      "event": "evt_034t7hC5IdP6CkXiafav33",
      "event_type": "webhook_endpoint.test",
      "attempt_count": 0,
      "next_attempt_at": 1794004695,
      "attempts": [],
      "created": 1794004695
    }
  ]
}