Envoyer un événement de test

POST/v1/webhook-endpoints/{webhookEndpoint}/test

Produit un événement webhook_endpoint.test, livré à ce seul point.

Droit de clé restreinte : webhooks:write.

Paramètres de chemin

webhookEndpointtexteobligatoire
L'identifiant, we_….

En-têtes

Idempotency-Keytexte
Rend le rejeu de cette écriture sûr pendant 24 heures. Idempotence.

Réponse

Rend le corps ci-contre.

Une erreur suit le format commun.

Requête

curl


curl -X POST https://api.ophelix.fr/v1/webhook-endpoints/we_…/test \
  -H "Authorization: Bearer sk_test_…"

PHP


$client = new GuzzleHttp\Client(['base_uri' => 'https://api.ophelix.fr']);
 
$response = $client->post('/v1/webhook-endpoints/we_…/test', [
    '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_…/test', {
  method: 'POST',
  headers: { Authorization: 'Bearer sk_test_…' },
})
const object = await response.json()

Réponse 200


{
  "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
}