Send a test event to a Webhook subscription

POST /v1/webhooks/{webhook_id}/test

Sends an obviously synthetic webhook.test event to this subscription through the production path, the same queue, signature, egress guard and delivery log, and answers 202 with the delivery pending (1.63.0; api.md section 7). The event reaches no other subscription and no event log. A subscription that is not active is 409 webhook_not_active, its status the detail's reason. From 1.64.0, stated as the api built it: since the test event takes no place in the log, its envelope carries the Organization's latest relayed sequence, at least 1, rather than one of its own, with livemode false and the delivery's event id and instant, so a receiver that discards stale updates by sequence must not treat a test as one.

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the webhooks:write scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl -X POST "$VOCAL_API/v1/webhooks/whk_.../test" \
  -H "Authorization: Bearer $VOCAL_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

const response = await fetch(`${process.env.VOCAL_API}/v1/webhooks/whk_.../test`, {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
    'Idempotency-Key': crypto.randomUUID(),
  },
});
console.log(response.status, await response.text());

import os
import uuid

import requests

response = requests.post(
    f"{os.environ['VOCAL_API']}/v1/webhooks/whk_.../test",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
)
print(response.status_code, response.text)

Parameters

Responses

Fields of the 202 answer

The shape is WebhookDelivery.