Layers
Partner APIAPI referenceWebhooks

POST /v1/webhook-endpoints/:endpointId/test

Enqueue a `test.ping` delivery against a registered endpoint. Useful before wiring real events.

View as Markdown
POST/v1/webhook-endpoints/{endpointId}/test
Phase 1stableidempotent
Auth
X-Api-Key

Fires a synthetic test.ping event at the endpoint's URL — the same signed delivery path real events take, so you can end-to-end verify your signature handling before subscribing to any real event types. This call bypasses the endpoint's events subscription filter (the endpoint doesn't need test.ping in its events list).

Body (optional)
  • payload
    objectoptional
    Custom payload.data override. If omitted, a default `{ message, endpointId, organizationId }` shape is used.

Example

curl -X POST https://api.layers.com/v1/webhook-endpoints/d4c71b62-.../test \
  -H "X-Api-Key: $LAYERS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"
200Accepted — delivery enqueued
{
  "eventId": "evt_01KPM7QZEC6NJF4XJTCZRR6S3N",
  "deliveryId": "9b8a41e2-0cc6-4c7a-9f89-1a7d19a1c233",
  "scheduledAt": "2026-04-20T18:28:00.000Z"
}

The dispatcher fires within ~1 minute. Verify receipt at your endpoint; check GET /webhook-endpoints/:id/deliveries if it didn't arrive.

Errors

StatusCodeWhen
404NOT_FOUNDEndpoint not owned by the calling org.
422VALIDATIONBody present but malformed.

On this page