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
Path parameters
uidstring · uuidRequired

Uid of Azure Service Bus connection

Responses
200

OK

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

{
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "Title": "text",
  "ServiceBusConnectionString": "text",
  "QueueName": "text",
  "BlobContainerConnectionString": "text",
  "BlobContainerName": "text",
  "Active": true,
  "EnabledEvents": [
    "text"
  ],
  "AdvancedSettings": {
    "ANY_ADDITIONAL_PROPERTY": {
      "EventSettingsType": "text"
    }
  }
}

Delete an Azure Service Bus connection

delete
Authorizations
Path parameters
uidstring · uuidRequired

Uid of Azure Service Bus connection to delete

Responses
200

OK

No content
delete
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
Responses
200

OK

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

OK

[
  {
    "Uid": "123e4567-e89b-12d3-a456-426614174000",
    "Title": "text",
    "ServiceBusConnectionString": "text",
    "QueueName": "text",
    "BlobContainerConnectionString": "text",
    "BlobContainerName": "text",
    "Active": true,
    "EnabledEvents": [
      "text"
    ],
    "AdvancedSettings": {
      "ANY_ADDITIONAL_PROPERTY": {
        "EventSettingsType": "text"
      }
    }
  }
]

Create a new Azure Service Bus connection

post
Authorizations
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
POST /v1/azureservicebusconnections HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 271

{
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "Title": "text",
  "ServiceBusConnectionString": "text",
  "QueueName": "text",
  "BlobContainerConnectionString": "text",
  "BlobContainerName": "text",
  "Active": true,
  "EnabledEvents": [
    "text"
  ],
  "AdvancedSettings": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}
200

OK

No content

Update an Azure Service Bus connection

put
Authorizations
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
PUT /v1/azureservicebusconnections HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 271

{
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "Title": "text",
  "ServiceBusConnectionString": "text",
  "QueueName": "text",
  "BlobContainerConnectionString": "text",
  "BlobContainerName": "text",
  "Active": true,
  "EnabledEvents": [
    "text"
  ],
  "AdvancedSettings": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}
200

OK

No content

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

get
Authorizations
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

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

OK

{
  "Messages": [
    {
      "Uid": "123e4567-e89b-12d3-a456-426614174000",
      "ConnectionUid": "123e4567-e89b-12d3-a456-426614174000",
      "EventKey": "text",
      "EventTimestamp": "2025-10-13T14:22:10.652Z",
      "RequestTimestamp": "2025-10-13T14:22:10.652Z",
      "MessageBody": "text",
      "ElapsedMilliseconds": 1,
      "RequestMetadata": "text",
      "Status": 1,
      "ParentServiceBusMessageUid": "123e4567-e89b-12d3-a456-426614174000",
      "IsRetry": true
    }
  ],
  "Page": 1,
  "TotalHits": 1
}

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

get
Authorizations
Path parameters
connectionUidstring · uuidRequired

Uid of azure service bus connection

messageUidstring · uuidRequired

Uid of the message

Responses
200

OK

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

OK

{
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "ConnectionUid": "123e4567-e89b-12d3-a456-426614174000",
  "EventKey": "text",
  "EventTimestamp": "2025-10-13T14:22:10.652Z",
  "RequestTimestamp": "2025-10-13T14:22:10.652Z",
  "MessageBody": "text",
  "ElapsedMilliseconds": 1,
  "RequestMetadata": "text",
  "Status": 1,
  "ParentServiceBusMessageUid": "123e4567-e89b-12d3-a456-426614174000",
  "IsRetry": true
}
PreviousMaintenanceNextMiscellaneous