Pay : webhooks

Envoyer un événement d’essai à un point

POST/v1/webhook_endpoints/{id}/test

Met en file un événement webhook_endpoint.test pour ce seul point. Les événements d’essai n’apparaissent jamais dans /v1/events.

Authentification: Clé d’API (Authorization: Bearer)
Portée requise: pay:write

Rejouable sans risque avec l’en-tête Idempotency-Key : voir Idempotence.

Paramètres de chemin#

idstring · uuidobligatoire

En-têtes#

Idempotency-Keystringobligatoire
Obligatoire sur tous les POST Pay ; rend la requête rejouable sans risque pendant 24 heures. Cloisonné par environnement de la clé.

de 1 à 255 caractères

Réponses#

202Événement d’essai mis en file.

Champs de l’objet

objectstring
Valeurs webhook_test
endpoint_idstring · uuid
event_idstring
statusstring
Valeurs queued

4xx · 5xxErreur.

Erreur au format standard : voir Erreurs.

Requête

cURL

curl -X POST "https://aicscan.io/v1/webhook_endpoints/0193a1d2-3c4d-7e5f-8a6b-7c8d9e0f1a2b/test" \
  -H "Authorization: Bearer $AICSCAN_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

JavaScript

const res = await fetch('https://aicscan.io/v1/webhook_endpoints/0193a1d2-3c4d-7e5f-8a6b-7c8d9e0f1a2b/test', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.AICSCAN_API_KEY}`,
    'Idempotency-Key': crypto.randomUUID(),
  },
});
const data = await res.json();
if (!res.ok) throw new Error(data.error.code);
console.log(data);

Python

import os, uuid
import requests

resp = requests.post(
    "https://aicscan.io/v1/webhook_endpoints/0193a1d2-3c4d-7e5f-8a6b-7c8d9e0f1a2b/test",
    headers={
        "Authorization": f"Bearer {os.environ['AICSCAN_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    timeout=10,
)
resp.raise_for_status()
print(resp.json())

Réponse 202

JSON

{
  "object": "webhook_test",
  "endpoint_id": "0193a1c9-41aa-7b2e-9c0d-1e2f3a4b5c6d",
  "event_id": "string",
  "status": "queued"
}