Settings | Event Subscriptions

Returns every event subscription for the tenant, active or not.

Credentials are omitted from every read: clientSecret comes back as null, and so does the value of any credential-carrying request header. The header's key is still returned, so you can see that an Authorization header is configured without being shown its value.

[
  {
    "id": "b7c1f0e2-4d3a-4f6b-9a21-0c5e8d7a1234",
    "name": "Order created to ERP",
    "isActive": true,
    "connector": "Webhook",
    "baseUrl": "https://erp.example.com",
    "requestUri": "/omnium/orders",
    "httpVerb": "POST",
    "clientId": "omnium-integration",
    "clientSecret": null,
    "requestHeaders": [
      { "key": "Authorization", "value": null },
      { "key": "X-Source", "value": "omnium" }
    ],
    "useQueueDelivery": true,
    "filters": { "classNames": ["Order"], "statuses": ["Created"], "markets": ["NOR"] }
  }
]
get/api/EventSubscriptions

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
  • Auth: API key in header Authorization

Response

Subscriptions returned. Credentials are omitted.

idstring nullable

Unique identifier. Assigned by Omnium when omitted on create; supply your own to keep ids stable across environments.

namestring required

Name shown in the UI and included in delivery log entries.

isActiveboolean

When false the subscription is kept but no events are delivered.

connectorstring required

Delivery mechanism. Built-in values are Webhook, AzureServiceBus, AzureStorageQueue, Kafka and RabbitMQ; installed integration modules may add more.

baseUrlstring nullable

Target host for HTTP delivery, for example https://example.com. Required by the Webhook connector.

requestUristring nullable

Path appended to Omnium.Public.Events.Models.OmniumEventSubscription.BaseUrl, for example /hooks/orders.

httpVerbstring nullable

HTTP method used for delivery, for example POST.

topicstring nullable

Queue, topic or stream name. Used by the queue and bus connectors instead of a URL.

clientIdstring nullable

Client id used to authenticate against the destination.

clientSecretstring nullable

Client secret or connection string used to authenticate against the destination. Write-only: always returned as null. Omit it on update to keep the stored value, or send an empty string to clear it.

messageEncodingstring nullable

Character encoding of the delivered message body, for example UTF-8.

useQueueDeliveryboolean

When true, events are put on an internal queue and delivered asynchronously with retries instead of being sent inline.

Changes

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