# Messaging
#Available from v.3.15.0 Azure service bus is used to implement a queue of system events that can be subscribed to by external systems.
GET /messagequeues Get all configured message queues
[
{
"Uid": "fce44950-9079-448e-9758-82db7ba977f0",
"Title": "Message queue integration",
"ServiceBusConnectionString": "https://someeventhub.com/triggerme",
"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": 2,
"DataModelType": 2
}
}
},
{
"Uid": "66ddbd27-1274-430c-aa35-a0c9166d0494",
"Title": "Message queue integration",
"ServiceBusConnectionString": "https://someeventhub.com/triggerme",
"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": 2,
"DataModelType": 2
}
}
}
]Response status OK (200)
| Property name | Data type | Description |
|---|---|---|
| Uid | string |
Unique id of the message queue connection |
| Title | string |
Title of message queue connection |
| ServiceBusConnectionString | string |
Url for the message queue to request when triggered |
| QueueName | string |
Queue name for the message queue |
| BlobContainerConnectionString | string |
Url for the blob storage to request when triggered |
| BlobContainerName | string | |
| Active | boolean |
Activate / deactivate message queue connection |
| EnabledEvents | array |
Events this message queue shall act on |
| AdvancedSettings | object |
Advanced settings for events supporting this message queue |
PUT /messagequeues Update a message queue
{
"Uid": "0ea0f593-5949-4dc1-995a-cfdebc3f70d8",
"Title": "Message queue integration",
"ServiceBusConnectionString": "https://someeventhub.com/triggerme",
"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": 2,
"DataModelType": 2
}
}
}Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| messageQueue | body | object : MessageQueueModel |
message queue to update |
| Property name | Data type | Description |
|---|---|---|
| Uid | string |
Unique id of the message queue connection |
| Title | string |
Title of message queue connection |
| ServiceBusConnectionString | string |
Url for the message queue to request when triggered |
| QueueName | string |
Queue name for the message queue |
| BlobContainerConnectionString | string |
Url for the blob storage to request when triggered |
| BlobContainerName | string | |
| Active | boolean |
Activate / deactivate message queue connection |
| EnabledEvents | array |
Events this message queue shall act on |
| AdvancedSettings | object |
Advanced settings for events supporting this message queue |
Response status OK (200)
POST /messagequeues Create a new message queue
{
"Uid": "d1995024-1851-49b8-89a1-6b8c573122c7",
"Title": "Message queue integration",
"ServiceBusConnectionString": "https://someeventhub.com/triggerme",
"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": 2,
"DataModelType": 2
}
}
}Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| messageQueue | body | object : MessageQueueModel |
message queue to create |
| Property name | Data type | Description |
|---|---|---|
| Uid | string |
Unique id of the message queue connection |
| Title | string |
Title of message queue connection |
| ServiceBusConnectionString | string |
Url for the message queue to request when triggered |
| QueueName | string |
Queue name for the message queue |
| BlobContainerConnectionString | string |
Url for the blob storage to request when triggered |
| BlobContainerName | string | |
| Active | boolean |
Activate / deactivate message queue connection |
| EnabledEvents | array |
Events this message queue shall act on |
| AdvancedSettings | object |
Advanced settings for events supporting this message queue |
Response status OK (200)
GET /messagequeues/{uid} Get a service bus configuration
#Available from v.3.15.0
{
"Uid": "28d733bc-7829-4058-8092-91c89c5c29fc",
"Title": "Message queue integration",
"ServiceBusConnectionString": "https://someeventhub.com/triggerme",
"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": 2,
"DataModelType": 2
}
}
}Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| uid | path | string |
Uid of message queue |
Response status OK (200)
| Property name | Data type | Description |
|---|---|---|
| Uid | string |
Unique id of the message queue connection |
| Title | string |
Title of message queue connection |
| ServiceBusConnectionString | string |
Url for the message queue to request when triggered |
| QueueName | string |
Queue name for the message queue |
| BlobContainerConnectionString | string |
Url for the blob storage to request when triggered |
| BlobContainerName | string | |
| Active | boolean |
Activate / deactivate message queue connection |
| EnabledEvents | array |
Events this message queue shall act on |
| AdvancedSettings | object |
Advanced settings for events supporting this message queue |
DELETE /messagequeues/{uid} Delete a message queue
Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| uid | path | string |
Uid of message queue to delete |