Pay: webhooks

Send a test event to an endpoint

POST/v1/webhook_endpoints/{id}/test

Queues a webhook_endpoint.test event for this endpoint only. Test events never appear in /v1/events.

Authentication: API key (Authorization: Bearer)
Required scope: pay:write

Safe to retry with the Idempotency-Key header: see Idempotency.

Path parameters#

idstring · uuidrequired

Headers#

Idempotency-Keystringrequired
Required on every Pay POST; makes it safe to retry for 24 hours. Scoped to the key's environment.

1 to 255 characters

Responses#

202Test event queued.

Object fields

objectstring
Values webhook_test
endpoint_idstring · uuid
event_idstring
statusstring
Values queued

4xx · 5xxError.

Standard error format: see Errors.

Request

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())

Response 202

JSON

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