Test fire webhook

Webhooks

POST/api/v1/scent/webhooks/{id}/test-fire

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

Path parameters

idstring (uuid)Required

Body parameters

eventTypestring (enum)Required

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

Response

idstring (uuid)

eventTypestring

eventIdstring

An opaque, stable per-event id (a SHA-256 of the internal idempotency key) — the SAME value delivered in the webhook body’s eventId. Correlate a delivery-list row to a received webhook, and dedupe, on this. It is opaque — do not parse it.

attemptNumberinteger

httpStatusinteger

sentAtstring (date-time)

succeededboolean

errorSummarystring

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

deadLetteredAtstring (date-time)

nextAttemptAtstring (date-time)

Other responses

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

401No bearer token (UNAUTHORIZED_MISSING_TOKEN), an invalid token (UNAUTHORIZED_INVALID_TOKEN) or an expired one (UNAUTHORIZED_TOKEN_EXPIRED — mint a new token). UPSTREAM_AUTH_FAILED is different: a dependent service refused the Gateway itself. That is a server-side fault — retry later and do NOT re-mint your token. See the Errors guide.

403The route is not available to your credential (FORBIDDEN).

404Unknown subscription.

415The request body is not sent as application/json (UNSUPPORTED_MEDIA_TYPE).

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

502A dependent service returned an invalid response (BAD_GATEWAY). Retry with backoff.

503The service is temporarily unavailable (SERVICE_UNAVAILABLE). Retry with backoff.

504A dependent service did not respond in time (GATEWAY_TIMEOUT). Retry with backoff.

cURL

curl --request POST \
  --url https://api-omni.linra.net/api/v1/scent/webhooks/5b1e3a1c-9d2e-4f3a-8b1c-9f0a2e3d4c5b/test-fire \
  --header 'Authorization: Bearer $TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "eventType": "order.completed"
  }'

JavaScript

const res = await fetch('https://api-omni.linra.net/api/v1/scent/webhooks/5b1e3a1c-9d2e-4f3a-8b1c-9f0a2e3d4c5b/test-fire', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${token}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    eventType: 'order.completed'
  }),
});
const { payload } = await res.json();

C#

var response = await httpClient.PostAsJsonAsync(
    "https://api-omni.linra.net/api/v1/scent/webhooks/5b1e3a1c-9d2e-4f3a-8b1c-9f0a2e3d4c5b/test-fire",
    new
    {
        eventType = "order.completed"
    });

var envelope = await response.Content.ReadFromJsonAsync<ApiResponse<WebhookDeliveryResponse>>();

Response

{
  "state": "SUCCESS",
  "payload": {
    "id": "5b1e3a1c-9d2e-4f3a-8b1c-9f0a2e3d4c5b",
    "eventType": "string",
    "eventId": "string",
    "attemptNumber": 0,
    "httpStatus": 0,
    "sentAt": "2026-08-22T09:14:03Z",
    "succeeded": true,
    "errorSummary": "string",
    "deadLetteredAt": "2026-08-22T09:14:03Z",
    "nextAttemptAt": "2026-08-22T09:14:03Z"
  },
  "details": null
}