Skip to content
Linra Omni Vendor Docs

Send a test delivery for a webhook subscription

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

Synthesizes a sample payload for the given (already-subscribed) event type and dispatches it through the SAME delivery path — including HMAC signing and the SSRF guardrails — a real event would use. Requires the Orders capability.

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
string
Allowed values: vendor.order.assigned vendor.offer.review-decision

Responses

Section titled “Responses”

200

Section titled “200”

The synthesized delivery attempt’s outcome.

Media typeapplication/json
object
state
required
string
payload
required
details
object
payload
required
object
id
string format: uuid
eventType
string
Allowed values: vendor.order.assigned vendor.offer.review-decision
idempotencyKey

Stable across every retry attempt of the SAME logical event — the same value that appears as eventId in the delivered envelope. Use it to dedupe.

string
attemptNumber
integer
httpStatus
integer
nullable
sentAt
string format: date-time
nullable
succeeded
boolean
errorSummary
string
nullable
deadLetteredAt
string format: date-time
nullable
nextAttemptAt
string format: date-time
Example
{
  "state": "SUCCESS",
  "payload": {
    "eventType": "vendor.order.assigned"
  }
}

400

Section titled “400”

The subscription isn’t subscribed to that event type.

Media typeapplication/json
object
state
required
string
payload
details
object
Examples
ExamplenotSubscribed
{
  "state": "VALIDATION_WEBHOOK_EVENT_TYPE_NOT_SUBSCRIBED",
  "payload": null,
  "details": {}
}

403

Section titled “403”

Your token doesn’t carry the capability this endpoint requires.

Media typeapplication/json
object
state
required
string
payload
details
object
Examples
ExamplemissingCapability
{
  "state": "FORBIDDEN_CAPABILITY_NOT_GRANTED",
  "payload": null,
  "details": {
    "requiredCapability": "Orders"
  }
}

404

Section titled “404”

Unknown subscription id.

Media typeapplication/json
object
state
required
string
payload
details
object
Examples
ExamplenotFound
{
  "state": "NOT_FOUND_VENDOR_WEBHOOK_SUBSCRIPTION",
  "payload": null,
  "details": {}
}

429

Section titled “429”

Too many requests. Retry after the Retry-After header (seconds).

Media typeapplication/json
object
state
required
string
payload
details
object
Example
{
  "state": "NOT_FOUND_VENDOR_OFFER"
}

Headers

Section titled “Headers”
Retry-After
integer

Seconds to wait before retrying.