POST /v1/webhook_endpoints/{webhook_id}/test

curl -X POST \
  -H "Authorization: Bearer $SECAPI_BEARER_TOKEN" \
  -H "secapi-version: 2026-03-19" \
  -H "content-type: application/json" \
  -d '{"eventType":"webhook.test","data":{"source":"dashboard"}}' \
  "https://api.secapi.ai/v1/webhook_endpoints/wh_example_123/test"

{
  "object": "webhook_test",
  "event": {
    "object": "event",
    "id": "evt_webhook_test_123",
    "type": "webhook.test",
    "createdAt": "2026-06-25T15:01:00.000Z",
    "livemode": false,
    "orgId": "org_example_123",
    "requestId": "req_2ZK8Q1W9F4M6P7R3",
    "data": {
      "message": "SEC API webhook test",
      "webhookId": "wh_2ZK8Q1W9F4M6P7R3",
      "requestedBy": "delivery_api"
    }
  },
  "delivery": {
    "kind": "webhook_delivery",
    "recordedAt": "2026-06-25T15:01:00.250Z",
    "orgId": "org_example_123",
    "eventId": "evt_webhook_test_123",
    "eventType": "webhook.test",
    "webhookId": "wh_2ZK8Q1W9F4M6P7R3",
    "destinationUrl": "https://example.com/hooks/secapi",
    "status": 200,
    "ok": true,
    "requestId": "req_2ZK8Q1W9F4M6P7R3",
    "error": null,
    "latencyMs": 250,
    "replayedFromDeliveryId": null
  },
  "requestId": "req_2ZK8Q1W9F4M6P7R3"
}

Send a signed webhook.test event to a webhook endpoint

Audience: application and admin.

Verify the receiver

A test emits webhook.test to an active endpoint and returns both the event and its recorded delivery attempt. Tests against a disabled endpoint return 409 webhook_disabled; any other requested event type returns 400 invalid_test_event_type. The payload is signed like other webhook events. Inspect the receiver’s signature verification and the returned status before relying on the integration.

Canonical metadata

requestId
traceparent

Example request

curl -X POST \
  -H "Authorization: Bearer $SECAPI_BEARER_TOKEN" \
  -H "secapi-version: 2026-03-19" \
  -H "content-type: application/json" \
  -d '{"eventType":"webhook.test","data":{"source":"dashboard"}}' \
  "https://api.secapi.ai/v1/webhook_endpoints/wh_example_123/test"

This organization control-plane action accepts bearer organization REST authentication. API keys cannot mutate webhook endpoints. The dashboard is optional.

Example response

{
  "object": "webhook_test",
  "event": {
    "object": "event",
    "id": "evt_webhook_test_123",
    "type": "webhook.test",
    "createdAt": "2026-06-25T15:01:00.000Z",
    "livemode": false,
    "orgId": "org_example_123",
    "requestId": "req_2ZK8Q1W9F4M6P7R3",
    "data": {
      "message": "SEC API webhook test",
      "webhookId": "wh_2ZK8Q1W9F4M6P7R3",
      "requestedBy": "delivery_api"
    }
  },
  "delivery": {
    "kind": "webhook_delivery",
    "recordedAt": "2026-06-25T15:01:00.250Z",
    "orgId": "org_example_123",
    "eventId": "evt_webhook_test_123",
    "eventType": "webhook.test",
    "webhookId": "wh_2ZK8Q1W9F4M6P7R3",
    "destinationUrl": "https://example.com/hooks/secapi",
    "status": 200,
    "ok": true,
    "requestId": "req_2ZK8Q1W9F4M6P7R3",
    "error": null,
    "latencyMs": 250,
    "replayedFromDeliveryId": null
  },
  "requestId": "req_2ZK8Q1W9F4M6P7R3"
}

Give this prompt to your agent

Failure posture

treat non-2xx responses as contract-aware failures, not free-form errors
preserve requestId and traceparent in logs and downstream reports
if provenance or freshness metadata is present, return it unchanged so trust is not lost in the handoff

​Verify the receiver

​Canonical metadata

​Example request

​Example response

​Give this prompt to your agent

​Failure posture

Verify the receiver

Canonical metadata

Example request

Example response

Give this prompt to your agent

Failure posture