Messaging

Azure service bus is used to implement a queue of system events that can be subscribed to by external systems.

Get an Azure Service Bus connections

get

#Available from v.3.15.0

Authorizations
AuthorizationstringRequired
Path parameters
uidstring · uuidRequired

Uid of Azure Service Bus connection

Responses
200

OK

application/json
get
/v1/azureservicebusconnections/{uid}
GET /v1/azureservicebusconnections/{uid} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "Uid": "e5ed584e-d321-4fc7-8049-80410cb0909e",
  "Title": "Message queue integration",
  "ServiceBusConnectionString": "https://someeventhub.com/triggerme",
  "QueueName": "",
  "BlobContainerConnectionString": "",
  "BlobContainerName": "",
  "Active": true,
  "EnabledEvents": [
    "variants:created",
    "variants:updated",
    "variants:deleted"
  ],
  "AdvancedSettings": {
    "variants:updated": {
      "ConditionalTriggering": true,
      "TriggerOnProductIdUpdates": false,
      "TriggerOnVariantGroupIdUpdates": false,
      "TriggerOnSortOrderUpdates": false,
      "TriggerOnVariantGroupSortOrderUpdates": false,
      "TriggerOnArchivingUpdates": false,
      "TriggerOnAttributeUpdates": {},
      "AttributesToTriggerOn": [],
      "DataModelType": {},
      "EventSettingsType": "VariantsUpdatedEventArgsAdvancedSettings"
    }
  }
}

Delete an Azure Service Bus connection

delete
Authorizations
AuthorizationstringRequired
Path parameters
uidstring · uuidRequired

Uid of Azure Service Bus connection to delete

Responses
200

OK

No content
delete
/v1/azureservicebusconnections/{uid}
DELETE /v1/azureservicebusconnections/{uid} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

No content

Get all Azure Service Bus connections

get
Authorizations
AuthorizationstringRequired
Responses
200

OK

application/json
get
/v1/azureservicebusconnections
GET /v1/azureservicebusconnections HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

[
  {
    "Uid": "fd548bc8-3262-4d94-ac51-c5c33d2370c0",
    "Title": "Message queue integration",
    "ServiceBusConnectionString": "https://someeventhub.com/triggerme",
    "QueueName": "",
    "BlobContainerConnectionString": "",
    "BlobContainerName": "",
    "Active": true,
    "EnabledEvents": [
      "variants:created",
      "variants:updated",
      "variants:deleted"
    ],
    "AdvancedSettings": {
      "variants:updated": {
        "ConditionalTriggering": true,
        "TriggerOnProductIdUpdates": false,
        "TriggerOnVariantGroupIdUpdates": false,
        "TriggerOnSortOrderUpdates": false,
        "TriggerOnVariantGroupSortOrderUpdates": false,
        "TriggerOnArchivingUpdates": false,
        "TriggerOnAttributeUpdates": {},
        "AttributesToTriggerOn": [],
        "DataModelType": {},
        "EventSettingsType": "VariantsUpdatedEventArgsAdvancedSettings"
      }
    }
  },
  {
    "Uid": "00a7aa9c-685c-458e-a6e3-c3c46a915414",
    "Title": "Message queue integration",
    "ServiceBusConnectionString": "https://someeventhub.com/triggerme",
    "QueueName": "",
    "BlobContainerConnectionString": "",
    "BlobContainerName": "",
    "Active": true,
    "EnabledEvents": [
      "variants:created",
      "variants:updated",
      "variants:deleted"
    ],
    "AdvancedSettings": {
      "variants:updated": {
        "ConditionalTriggering": true,
        "TriggerOnProductIdUpdates": false,
        "TriggerOnVariantGroupIdUpdates": false,
        "TriggerOnSortOrderUpdates": false,
        "TriggerOnVariantGroupSortOrderUpdates": false,
        "TriggerOnArchivingUpdates": false,
        "TriggerOnAttributeUpdates": {},
        "AttributesToTriggerOn": [],
        "DataModelType": {},
        "EventSettingsType": "VariantsUpdatedEventArgsAdvancedSettings"
      }
    }
  }
]

Create a new Azure Service Bus connection

post
Authorizations
AuthorizationstringRequired
Body

Model representing a message queue connection

Uidstring · uuidOptional

Unique id of the message queue connection

Titlestring | nullableOptional

Title of message queue connection

ServiceBusConnectionStringstring | nullableOptional

Url for the message queue to request when triggered

QueueNamestring | nullableOptional

Queue name for the message queue

BlobContainerConnectionStringstring | nullableOptional

Url for the blob storage to request when triggered

BlobContainerNamestring | nullableOptional
ActivebooleanOptional

Activate / deactivate message queue connection

EnabledEventsstring[] | nullableOptional

Events this message queue shall act on

Responses
200

OK

No content
post
/v1/azureservicebusconnections
POST /v1/azureservicebusconnections HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 708

{
  "Uid": "48c43f09-8a77-4cea-b190-166ee96400c8",
  "Title": "Message queue integration",
  "ServiceBusConnectionString": "https://someeventhub.com/triggerme",
  "QueueName": "",
  "BlobContainerConnectionString": "",
  "BlobContainerName": "",
  "Active": true,
  "EnabledEvents": [
    "variants:created",
    "variants:updated",
    "variants:deleted"
  ],
  "AdvancedSettings": {
    "variants:updated": {
      "ConditionalTriggering": true,
      "TriggerOnProductIdUpdates": false,
      "TriggerOnVariantGroupIdUpdates": false,
      "TriggerOnSortOrderUpdates": false,
      "TriggerOnVariantGroupSortOrderUpdates": false,
      "TriggerOnArchivingUpdates": false,
      "TriggerOnAttributeUpdates": {},
      "AttributesToTriggerOn": [],
      "DataModelType": {},
      "EventSettingsType": "VariantsUpdatedEventArgsAdvancedSettings"
    }
  }
}
200

OK

No content

Update an Azure Service Bus connection

put
Authorizations
AuthorizationstringRequired
Body

Model representing a message queue connection

Uidstring · uuidOptional

Unique id of the message queue connection

Titlestring | nullableOptional

Title of message queue connection

ServiceBusConnectionStringstring | nullableOptional

Url for the message queue to request when triggered

QueueNamestring | nullableOptional

Queue name for the message queue

BlobContainerConnectionStringstring | nullableOptional

Url for the blob storage to request when triggered

BlobContainerNamestring | nullableOptional
ActivebooleanOptional

Activate / deactivate message queue connection

EnabledEventsstring[] | nullableOptional

Events this message queue shall act on

Responses
200

OK

No content
put
/v1/azureservicebusconnections
PUT /v1/azureservicebusconnections HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 708

{
  "Uid": "0031e507-06f1-4925-90e5-e0dea0023069",
  "Title": "Message queue integration",
  "ServiceBusConnectionString": "https://someeventhub.com/triggerme",
  "QueueName": "",
  "BlobContainerConnectionString": "",
  "BlobContainerName": "",
  "Active": true,
  "EnabledEvents": [
    "variants:created",
    "variants:updated",
    "variants:deleted"
  ],
  "AdvancedSettings": {
    "variants:updated": {
      "ConditionalTriggering": true,
      "TriggerOnProductIdUpdates": false,
      "TriggerOnVariantGroupIdUpdates": false,
      "TriggerOnSortOrderUpdates": false,
      "TriggerOnVariantGroupSortOrderUpdates": false,
      "TriggerOnArchivingUpdates": false,
      "TriggerOnAttributeUpdates": {},
      "AttributesToTriggerOn": [],
      "DataModelType": {},
      "EventSettingsType": "VariantsUpdatedEventArgsAdvancedSettings"
    }
  }
}
200

OK

No content

Get messages sent to the service bus. Note that messages is only stored for 14 days

get
Authorizations
AuthorizationstringRequired
Path parameters
connectionUidstring · uuidRequired

Uid of azure service bus connection

Query parameters
sincestring · date-timeOptional

return messages newer than this timestamp

onlyFailedbooleanOptional

Only return failed messages

pageinteger · int32Optional

Page to get (1 is first page)

Responses
200

OK

application/json
get
/v1/azureservicebusconnections/{connectionUid}/messages
GET /v1/azureservicebusconnections/{connectionUid}/messages HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

{
  "Messages": [
    {
      "Uid": "715782e7-e7a6-4b81-859b-ba796959e702",
      "ConnectionUid": "5a5c53eb-08a7-45cc-819d-0bdc9d12a976",
      "EventKey": "products:updated",
      "EventTimestamp": "2025-11-03T22:40:48.6892301+01:00",
      "RequestTimestamp": "2025-11-03T22:40:48.6992454+01:00",
      "MessageBody": "{\"ProductChanges\":[{\"Id\":438,\"UpdatedAttributes\":[\"DisplayOnWebshop\"]}],\"TransactionUid\":\"24c7b1da-4607-4189-9a4b-29556b4eeda3\"}",
      "ElapsedMilliseconds": 57,
      "RequestMetadata": "",
      "Status": {},
      "ParentServiceBusMessageUid": "468759aa-a1c2-4624-a53c-b46a9978a1d0",
      "IsRetry": false
    }
  ],
  "Page": 1,
  "TotalHits": 1
}

Get a specific message sent to the service bus. Note that messages are only stored for 14 days

get
Authorizations
AuthorizationstringRequired
Path parameters
connectionUidstring · uuidRequired

Uid of azure service bus connection

messageUidstring · uuidRequired

Uid of the message

Responses
200

OK

application/json
get
/v1/azureservicebusconnections/{connectionUid}/messages/{messageUid}
GET /v1/azureservicebusconnections/{connectionUid}/messages/{messageUid} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

[
  {
    "Uid": "715782e7-e7a6-4b81-859b-ba796959e702",
    "ConnectionUid": "5a5c53eb-08a7-45cc-819d-0bdc9d12a976",
    "EventKey": "products:updated",
    "EventTimestamp": "2025-11-03T22:40:48.6902706+01:00",
    "RequestTimestamp": "2025-11-03T22:40:48.7002731+01:00",
    "MessageBody": "{\"ProductChanges\":[{\"Id\":438,\"UpdatedAttributes\":[\"DisplayOnWebshop\"]}],\"TransactionUid\":\"24c7b1da-4607-4189-9a4b-29556b4eeda3\"}",
    "ElapsedMilliseconds": 57,
    "RequestMetadata": "",
    "Status": {},
    "ParentServiceBusMessageUid": "673ad587-86d8-4d67-9803-1d84147af951",
    "IsRetry": false
  }
]
PreviousMaintenanceNextMiscellaneous

Last updated