Skip to content
Linra Omni Developer Docs

Send a real, signed test delivery for one event type

POST
/api/v1/webhooks/{id}/test-fire
curl --request POST \
  --url https://api-omni.linra.net/api/v1/webhooks/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/test-fire \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "eventType": "order.completed" }'

Exercises the exact same signing/delivery/retry code path as a real event — useful for verifying your HMAC verification code before going live.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
eventType
required

The exact wire values of eventType — see the Webhooks guide.

string
Allowed values: order.completed order.failed order.cancelled order.returned order.fulfilment-updated variant.back-in-stock order.return-request.updated

Responses

Section titled “Responses”

200

Section titled “200”

The resulting delivery attempt.

Media typeapplication/json
object
state
required
string
payload
required
details
object
payload
required
object
id
string format: uuid
eventType
string
idempotencyKey

Identical across every retry attempt of the same logical event — dedupe on this.

string
attemptNumber
integer
httpStatus
integer
nullable
sentAt
string format: date-time
nullable
succeeded
boolean
errorSummary

A fixed vocabulary only — never a raw exception message: “Timeout”, “Connection failed”, “Destination rejected”, “Delivery failed”.

string
nullable
deadLetteredAt
string format: date-time
nullable
nextAttemptAt
string format: date-time
Example
{
  "state": "SUCCESS"
}

400

Section titled “400”

The event type is not in this subscription’s eventTypes.

Media typeapplication/json

The envelope every /api/v1 ERROR response uses. state carries the machine-readable error code (see the Errors guide).

object
state
required
string
payload
required

Always null on an error response.

object
details
object
Examples
ExamplenotSubscribed
{
  "state": "VALIDATION_WEBHOOK_EVENT_TYPE_NOT_SUBSCRIBED",
  "payload": null,
  "details": {}
}

404

Section titled “404”

Unknown subscription.

Media typeapplication/json

The envelope every /api/v1 ERROR response uses. state carries the machine-readable error code (see the Errors guide).

object
state
required
string
payload
required

Always null on an error response.

object
details
object
Example
{
  "state": "NOT_FOUND_ORDER",
  "payload": null
}

429

Section titled “429”

Too many requests — see the Rate limits guide. Retry after the Retry-After header (seconds).

Media typeapplication/json

The envelope every /api/v1 ERROR response uses. state carries the machine-readable error code (see the Errors guide).

object
state
required
string
payload
required

Always null on an error response.

object
details
object
Example
{
  "state": "NOT_FOUND_ORDER",
  "payload": null
}

Headers

Section titled “Headers”
Retry-After
integer

Seconds to wait before retrying.