Settings | Event Subscriptions

Delivers a single test event to a stored subscription's destination, so a pipeline can verify connectivity and credentials right after creating it.

The subscription does not have to be active, and no filters are applied — the test event is synthetic, not a real one, so this is safe to call against a production subscription. The destination receives one message and nothing is written back to Omnium.

The call returns 200 whether or not the delivery worked; read isSuccess for the outcome. A refused connection, a 401 from the destination or a connector name with no exporter behind it are all configuration answers rather than server faults.

{ "isSuccess": true, "message": "Delivered to https://erp.example.com/omnium/orders", "errorMessage": null, "responseContent": "" }

{ "isSuccess": false, "message": null, "errorMessage": "401 Unauthorized", "responseContent": "{\"error\":\"invalid token\"}" }
post/api/EventSubscriptions/{id}/Test

Request

  • Base URL: https://api.omnium.no (the document declares no server; this is the origin it was published from)
  • URL: https://api.omnium.no/api/EventSubscriptions/{id}/Test
  • Auth: API key in header Authorization

Path parameters

idstring nullable required

Id of the subscription to test.

Response

The test ran. Check isSuccess for the outcome.

isSuccessboolean

True when the destination accepted the test event.

messagestring nullable

Human readable summary of what happened.

errorMessagestring nullable

Why the delivery failed. Null when Omnium.Public.Events.Models.OmniumEventSubscriptionTestResult.IsSuccess is true.

responseContentstring nullable

Raw body returned by the destination, when it returned one.

Changes

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