Webhooks

Send test webhook

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

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

Path parameters

idstring required

Webhook subscription ID.

Response

Test delivery was queued and attempted.

Example response

{
  "data": {
    "ok": true,
    "deliveryId": "whd_123",
    "status": "succeeded",
    "responseStatus": 204
  },
  "meta": {
    "apiVersion": "v0"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.