Settings | Event Subscriptions

Replaces an event subscription. Send the whole object — every field is overwritten, so an omitted filter list clears that filter.

Credentials are the one exception, and it is what makes replace safe

A read never returns clientSecret or credential header values, so the obvious GET → change a field → PUT round trip would otherwise erase them. Instead:

You sendResult
the field omitted, or nullthe stored credential is kept
"" (empty string)the stored credential is cleared
any other valuethe credential is replaced

So a pipeline can read a subscription, edit one field and write it straight back without ever handling the secret.

Turning a subscription off, after reading it with GET

{
  "name": "Order created to ERP",
  "isActive": false,
  "connector": "Webhook",
  "baseUrl": "https://erp.example.com",
  "requestUri": "/omnium/orders",
  "httpVerb": "POST",
  "clientSecret": null,
  "requestHeaders": [
    { "key": "Authorization", "value": null },
    { "key": "X-Source", "value": "omnium" }
  ],
  "filters": { "classNames": ["Order"], "statuses": ["Created"], "markets": ["NOR"] }
}

The nulls here are exactly what GET returned, and they leave the stored secret and the stored Authorization value untouched.

Rotating the secret — send the new value instead of the null:

{ "clientSecret": "the-new-secret-value" }

(as part of the full object — this is a replace, not a patch).

An id in the body is ignored; the one in the route wins.

put/api/EventSubscriptions/{id}

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

Path parameters

idstring nullable required

Id of the subscription to replace.

Request body

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.

Response

Subscription updated. Credentials are omitted from the response.

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.