Send a test event

POSThttps://api.norreach.app/v1/webhook-endpoints/{id}/test

Queues a signed ping event to the endpoint (it arrives within a minute). Follow it with GET /webhook-deliveries/{id}.

webhooks:writeRole must allow: api.keysOperation id: test_webhook_endpoint

POST/webhook-endpoints/{id}/test

curl -X POST "https://api.norreach.app/v1/webhook-endpoints/{id}/test" \
  -H "Authorization: Bearer $NORREACH_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

Send a test event

{
  "id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
  "object": "webhook_delivery",
  "endpoint_id": "0f1a2b3c-4d5e-4f6a-8b7c-9d0e1f2a3b4c",
  "event_id": null,
  "event_type": "ping",
  "status": "pending",
  "attempt": 0,
  "next_attempt_at": "2026-11-04T09:12:33.120Z",
  "response_status": null,
  "response_ms": null,
  "response_excerpt": null,
  "payload": null,
  "created_at": "2026-11-04T09:12:33.120Z",
  "delivered_at": null
}

Authorizations

Authorizationstringheaderrequired

Bearer authentication: send Authorization: Bearer <key>, with an API key or an OAuth access token. The key needs the scope webhooks:write. API keys and scopes

Path parameters

idstring (uuid)pathrequired

An id (UUID).

Headers

Idempotency-Keystringheader

Any unique string (≤ 255). The same key with the same request returns the first answer for 24 hours.

Response

202application/json— Send a test event

idstring (uuid)required

An id (UUID).

object"webhook_delivery"required

endpoint_idstring (uuid)required

An id (UUID).

event_idstring | nullrequired

event_typestringrequired

statusenumrequired

One of:pendingsucceededfailedabandoned

attemptintegerrequired

next_attempt_atstring | nullrequired

response_statusinteger | nullrequired

response_msinteger | nullrequired

response_excerptstring | nullrequired

The first 1 KB of your endpoint's answer.

payloadobject | nullrequired

The exact body sent (null until the first attempt).

created_atstringrequired

RFC 3339 UTC timestamp with milliseconds.

delivered_atstring | nullrequired

Errors

Errors are application/problem+json with a stable code.

Status	Code	Meaning
400	`bad_request`	The request couldn't be read.
400	`unknown_field`	The request has a field this operation doesn't know.
401	`unauthorized`	A valid API key is required.
403	`insufficient_scope`	This API key doesn't have the scope this operation needs.
403	`feature_not_enabled`	The API isn't switched on for this workspace.
403	`role_forbidden`	The key's creator's role can't do this.
404	`not_found`	That doesn't exist.
409	`idempotency_in_progress`	A request with this Idempotency-Key is still running.
409	`conflict`	That conflicts with the current state.
413	`too_large`	The request body is too large.
422	`validation_failed`	The request has invalid fields.
422	`idempotency_mismatch`	This Idempotency-Key was used with a different request.
429	`rate_limited`	Too many requests. Slow down and try again.
500	`server_error`	Something went wrong on our side.
503	`unavailable`	The API isn't available right now. Try again shortly.

POST/webhook-endpoints/{id}/test

curl -X POST "https://api.norreach.app/v1/webhook-endpoints/{id}/test" \
  -H "Authorization: Bearer $NORREACH_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

Send a test event

{
  "id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
  "object": "webhook_delivery",
  "endpoint_id": "0f1a2b3c-4d5e-4f6a-8b7c-9d0e1f2a3b4c",
  "event_id": null,
  "event_type": "ping",
  "status": "pending",
  "attempt": 0,
  "next_attempt_at": "2026-11-04T09:12:33.120Z",
  "response_status": null,
  "response_ms": null,
  "response_excerpt": null,
  "payload": null,
  "created_at": "2026-11-04T09:12:33.120Z",
  "delivered_at": null
}