---
title: "Send test webhook"
method: POST
path: "/v0/webhooks/{id}/test"
tags: ["Webhooks"]
---

# Send test webhook

`POST /v0/webhooks/{id}/test`

## Request

- Base URL: `https://test-api.shodai.network`
- URL: `https://test-api.shodai.network/v0/webhooks/{id}/test`
- Auth: one of:
  - API key in header `X-API-Key`
  - HTTP bearer

Sends a signed test payload to a webhook subscription. The signing secret is not returned after creation.

## Path parameters

- `id` string, required

## Response `201`

Test delivery was queued and attempted.

- object
  - `data` WebhookTestResponse, required
    - `ok` boolean, required: True only when the immediate test delivery attempt succeeded.
    - `deliveryId` string, required: Delivery record ID for the test send.
    - `status` 'pending' | 'succeeded' | 'failed' | 'retry_pending', required: Recorded status after the immediate test delivery attempt.
    - `responseStatus` number: HTTP status returned by the webhook receiver when available.
    - `error` string: Failure reason recorded for failed or retry-pending test deliveries.
  - `meta` ResponseMeta, required
    - `apiVersion` string, required
    - `requestId` string, required: Correlation ID for support and debugging.

## Other responses

- `401`: Missing or invalid API credential.
- `402`: The authenticated Shodai account has paid_required entitlement mode for the requested scope. Per-call x402 settlement is not implemented. Treat this as an entitlement/operator issue.
- `403`: The credential lacks the required OAuth scope, the account lacks entitlement, or the account cannot access the resource.
- `404`: Webhook subscription not found.

---

[API](https://skmtc.dev/shodai/apis/agreements-api.md) · [All operations](https://skmtc.dev/shodai/apis/agreements-api/llms.txt) · [OpenAPI document](https://skmtc.dev/shodai/apis/agreements-api/revisions/0ac329d0e9a0?raw)