Send a test event

POST/webhooks/{webhookId}/test

Signed in

Sends a webhook.test event to it now, on or off, whatever it subscribes to, and answers what happened. Sent once, never retried, never counted against it.

SDK method: collector.testMyWebhook()
Key scopes: webhooks:write
Headers: X-Request-Id

Path parameters

webhookIdstring (uuid)required

Responses

200OKThe test delivery and its attempt.

WebhookDeliveryDetail

A delivery with its event and every attempt.

deliveryWebhookDeliveryrequired
eventmap of anyrequired
The body each attempt POSTs: the event (id, type, version, createdAt, test, owner, data).
attemptsarray of WebhookAttemptrequired

4Errors401 · 404 · 429 · 500

401
unauthorized
unauthorized: Not signed in (no session or token, or an expired one).
404
not_found
not_found: Nothing at that address.
429
rate_limited temporarily_blocked
rate_limited: Over the caller’s limit: the per-minute burst or the per-day quota (RateLimit headers; wait Retry-After seconds).
temporarily_blocked: Too many refused requests in a row: blocked for a while (Retry-After says how long).
500
internal
internal: Something went wrong on our side (quote the requestId).

curl -X POST 'https://api.collection.id/v1/webhooks/1c9e8b7a-6d5f-4e3c-9b2a-1f0e9d8c7b6a/test' \
  -H "Authorization: Bearer $COLLECTOR_TOKEN"

{
  "delivery": {
    "id": "2d0f9c8b-7e6a-4f5d-8c3b-2a1f0e9d8c7b",
    "webhookId": "1c9e8b7a-6d5f-4e3c-9b2a-1f0e9d8c7b6a",
    "eventId": "d1e2f3a4-b5c6-4d7e-8f90-a1b2c3d4e5f6",
    "eventType": "webhook.test",
    "status": "delivered",
    "attempts": 1,
    "test": true,
    "manual": true,
    "redeliveryOf": null,
    "createdAt": "2026-10-12T15:04:05.123Z",
    "lastAttemptAt": "2026-10-12T15:04:05.123Z",
    "nextAttemptAt": null,
    "deliveredAt": "2026-10-12T15:04:05.123Z",
    "responseStatus": 204,
    "latencyMs": 94,
    "error": null
  },
  "event": {
    "id": "d1e2f3a4-b5c6-4d7e-8f90-a1b2c3d4e5f6",
    "type": "webhook.test",
    "version": 1,
    "createdAt": "2026-10-12T15:04:05.123Z",
    "test": true,
    "owner": {
      "kind": "personal",
      "id": "0e6b1c52-8f43-4b8e-9d0c-5a7e2f1b3c4d"
    },
    "data": {
      "webhookId": "1c9e8b7a-6d5f-4e3c-9b2a-1f0e9d8c7b6a",
      "message": "A test event from The Collector. If you can read this, your endpoint works."
    }
  },
  "attempts": [
    {
      "attempt": 1,
      "at": "2026-10-12T15:04:05.123Z",
      "succeeded": true,
      "responseStatus": 204,
      "latencyMs": 94,
      "error": null,
      "responseBody": null
    }
  ]
}

Responses

200OKThe test delivery and its attempt.

WebhookDeliveryDetail

A delivery with its event and every attempt.

deliveryWebhookDeliveryrequired
eventmap of anyrequired
The body each attempt POSTs: the event (id, type, version, createdAt, test, owner, data).
attemptsarray of WebhookAttemptrequired

4Errors401 · 404 · 429 · 500

401
unauthorized
unauthorized: Not signed in (no session or token, or an expired one).
404
not_found
not_found: Nothing at that address.
429
rate_limited temporarily_blocked
rate_limited: Over the caller’s limit: the per-minute burst or the per-day quota (RateLimit headers; wait Retry-After seconds).
temporarily_blocked: Too many refused requests in a row: blocked for a while (Retry-After says how long).
500
internal
internal: Something went wrong on our side (quote the requestId).

{ "delivery": { "id": "2d0f9c8b-7e6a-4f5d-8c3b-2a1f0e9d8c7b", "webhookId": "1c9e8b7a-6d5f-4e3c-9b2a-1f0e9d8c7b6a", "eventId": "d1e2f3a4-b5c6-4d7e-8f90-a1b2c3d4e5f6", "eventType": "webhook.test", "status": "delivered", "attempts": 1, "test": true, "manual": true, "redeliveryOf": null, "createdAt": "2026-10-12T15:04:05.123Z", "lastAttemptAt": "2026-10-12T15:04:05.123Z", "nextAttemptAt": null, "deliveredAt": "2026-10-12T15:04:05.123Z", "responseStatus": 204, "latencyMs": 94, "error": null }, "event": { "id": "d1e2f3a4-b5c6-4d7e-8f90-a1b2c3d4e5f6", "type": "webhook.test", "version": 1, "createdAt": "2026-10-12T15:04:05.123Z", "test": true, "owner": { "kind": "personal", "id": "0e6b1c52-8f43-4b8e-9d0c-5a7e2f1b3c4d" }, "data": { "webhookId": "1c9e8b7a-6d5f-4e3c-9b2a-1f0e9d8c7b6a", "message": "A test event from The Collector. If you can read this, your endpoint works." } }, "attempts": [ { "attempt": 1, "at": "2026-10-12T15:04:05.123Z", "succeeded": true, "responseStatus": 204, "latencyMs": 94, "error": null, "responseBody": null } ] }