Webhooks

Send a test webhook

Send one signed test delivery of an event type's sample payload to an endpoint, once and without retries.

post/v1/webhook-endpoints/{webhook_endpoint_id}/test

Request

  • Base URL: https://api.scrip.dev
  • URL: https://api.scrip.dev/v1/webhook-endpoints/{webhook_endpoint_id}/test
  • Auth: HTTP bearer

Path parameters

webhook_endpoint_idstring uuid required

The webhook endpoint's id.

Headers

Idempotency-Keystring

A key you choose to make this request safe to retry: 1 to 255 printable ASCII characters. Send the same key with the same request to get the first response again, marked Idempotent-Replayed: true. Routes that return a secret once, and claim links, do not replay a response. Event ingest uses the key as the event's identity.

Request body

event_typestring required

The event type whose sample payload to send, for example balance.credited. List the types with GET /v1/webhook-event-types.

Example request

{
  "event_type": "balance.credited"
}

Response

Test delivery accepted

attempt_countinteger

Number of delivery attempts made so far

created_atstring date-time

When the delivery record was created

delivered_atstring date-time

When the delivery was successfully completed

error_codestring

Stable, machine-readable classification of the last failed attempt, e.g. consumer_response_timeout, consumer_4xx, consumer_5xx, rate_limited, gone (omitted when none)

event_typestring

The event type (e.g. balance.credited)

idstring uuid

The id of the delivery. Use it in delivery_id paths to retry or resend it.

last_attempt_atstring date-time

When the last attempt was made

last_errorstring

Error message from the last attempt (network errors, timeouts)

last_response_bodystring

Response body from the last attempt (truncated to 4 KB)

last_response_statusinteger

HTTP status code from the last attempt

max_attemptsinteger

Maximum attempts before marking as FAILED

next_attempt_atstring date-time

When Scrip will try the delivery next. Omitted once the delivery is DELIVERED or FAILED.

resend_seqinteger

Manual-resend sequence: 0 = the original delivery, 1,2,... = manual resends

status'PENDING' | 'SENDING' | 'DELIVERED' | 'FAILED'

Where the delivery is in its attempt lifecycle. PENDING deliveries wait for their next attempt. A PENDING delivery stays PENDING while its endpoint is disabled or paused, and resumes when the endpoint is active again. FAILED is final: attempts ran out, the receiver answered 410 Gone, or the endpoint was archived.

updated_atstring date-time

When the delivery record was last updated

webhook_endpoint_idstring uuid

The endpoint this delivery targets

webhook_event_idstring uuid

The webhook event that triggered this delivery

Example response

{
  "attempt_count": 1,
  "created_at": "2027-01-15T10:30:00Z",
  "delivered_at": "2027-01-15T10:30:00Z",
  "error_code": "consumer_response_timeout",
  "event_type": "balance.credited",
  "id": "1c8d3e5f-2a47-4b96-8e03-d5f7a9b1c2e4",
  "last_attempt_at": "2027-01-15T10:30:00Z",
  "last_error": "connection timed out after 10s",
  "last_response_body": "{\"received\":true}",
  "last_response_status": 200,
  "max_attempts": 8,
  "next_attempt_at": "2027-12-31T23:59:59Z",
  "status": "DELIVERED",
  "updated_at": "2027-01-15T10:30:00Z",
  "webhook_endpoint_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "webhook_event_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}

Changes

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