Skip to main content
POST
Send a test event

Authorizations

Authorization
string
header
required

Workspace API key (lora_sk_…) sent as Authorization: Bearer <api_key>. Each scoped operation names the scope it requires in its security requirement, for example shortcuts.write; a key without it receives 403 with code: insufficient_scope. GET /v1/qr also accepts anonymous requests and requires no scope.

Scopes

webhooks.write

Path Parameters

id
string
required

The endpoint's unique ID, wh_ and a UUID.

Pattern: ^wh_[0-9a-f-]{36}$
Example:

"wh_0198f2a4-7c1b-7d3e-9a52-3f6b1c2d4e5f"

Body

application/json

Options for a test send. The body may be left out.

event
enum<string>
default:shortcut.created

The event type to send a sample of. Defaults to shortcut.created.

Available options:
shortcut.created,
shortcut.updated,
shortcut.deleted
Example:

"shortcut.created"

Response

The test delivery, with its attempt. A receiver that answered with an error, or did not answer, is not an error of this request: look at the delivery's status and its attempt.

One event on its way to one endpoint, with every attempt made. Deliveries are listed for 30 days.

attemptCount
integer
required

How many attempts the delivery has had.

Required range: -9007199254740991 <= x <= 9007199254740991
attempts
object[]
required

The attempts, oldest first.

completedAt
string<date-time> | null
required

When the delivery ended, or null while it is pending.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
createdAt
string<date-time>
required

When the delivery was queued, ISO 8601.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
endpointId
string
required

The endpoint's unique ID.

Pattern: ^wh_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Example:

"wh_0198f2a4-7c1b-7d3e-9a52-3f6b1c2d4e5f"

event
enum<string> | null
required

The event's type, or null when the stored event is gone.

Available options:
shortcut.created,
shortcut.updated,
shortcut.deleted
Example:

"shortcut.created"

eventId
string
required

The event's unique ID. A real event uses evt_ and a UUID, a test send evt_test_ and a UUID, and a sample from the sample operation evt_sample_ and the event name. The same for every delivery, retry and resend of the event. Deduplicate on it, or on the webhook-id header, which carries the same value.

Example:

"evt_0198f2a4-7c1b-7d3e-9a52-3f6b1c2d4e5f"

id
string
required

The delivery's unique ID.

Example:

"0198f2a4-7c1b-7d3e-9a52-3f6b1c2d4e5f"

lastError
string | null
required

What went wrong at the last failed attempt, in a sentence.

nextAttemptAt
string<date-time> | null
required

When the next attempt is due, while the delivery is pending.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
outcome
string | null
required

The detail behind status, for example delivered, retry_exhausted, gone or not_sendable.

status
enum<string>
required

pending: waiting for an attempt or a retry. succeeded: the receiver answered 2xx. failed: ended without success, because retries ran out or the failure cannot be retried. skipped: not sent, because the shortcut is private, unlisted or deleted by now, the endpoint is off, or the plan no longer includes webhooks. canceled: the endpoint's URL changed, an event type was removed from it, or it was turned off or deleted. quarantined: Lora stopped processing the delivery after repeated internal errors. expired: reserved; webhook endpoints do not use it today.

Available options:
pending,
succeeded,
failed,
skipped,
canceled,
expired,
quarantined