---
title: Delivery configuration
slug: delivery-configuration
abstract: Delivery configuration defines message routing destinations.
content_type: concept
audience: \[architect, developer]
---
# Delivery configuration

## Overview

Delivery configuration defines message routing destinations. Two configuration types are available:

1. Custom integrations:
   - Kafka instances
   - EventHub instances
   - HTTP endpoints
   - Azure Blob storage
   - Azure Tables
   - CosmosDB databases
   - Message Senders

2. Known integrations:
   - SearchIngestion API
   - Discover Event API
   - Send Event API
   - Mailchimp API
   - Content Hub Integration

Integration limitations:

- SearchIngestion API: ProductSync only
- Discover/Send Event API: TrackingEvent only
- Content Hub: ProductSync only

Custom integrations support all integration points with multiple target combinations.

## Configuration models

### DeliveryConfig structure

```json
{
  "ID": "",
  "Name": "",
  "Enabled": true,
  "DeliveryTargets": {}
}
```

### DeliveryTargets options

```json
{
  "Kafka": {},
  "Http": {},
  "EventHub": {},
  "SendEvent": {},
  "DiscoverEvent": {},
  "AzureBlob": {}
}
```

### Integration configurations

#### Kafka settings

```json
{
  "BootstrapServers": "",
  "SaslUsername": "",
  "SaslPassword": "",
  "Topic": ""
}
```

#### HTTP configuration

```json
{
  "Endpoint": "",
  "Secret": ""
}
```

Note: Secret enables [webhook verification](https://doc.sitecore.com/ordercloud/en/developers/platform/webhooks.html#request-verification)

#### EventHub settings

```json
{
  "ConnectionString": "",
  "EventHubName": ""
}
```

#### Azure storage options

Blob storage:

```json
{
  "ConnectionString": "",
  "OverrideContainerName": ""
}
```

Table storage:

```json
{
  "ConnectionString": "",
  "OverrideTableName": ""
}
```

#### Database configurations

CosmosDB:

```json
{
  "ConnectionString": "",
  "OverrideDatabaseName": ""
}
```

#### Messaging settings

MessageSender:

```json
{
  "Secret": "",
  "EndPoint": ""
}
```

#### Integration APIs

SearchIngestion:

```json
{
  "Domain": "",
  "Source": "",
  "Endpoint": "",
  "Entity": "",
  "ApiKey": "",
  "Content": {
    "Locales": ["", ""],
    "Http": {
      "Endpoint": "",
      "CustomAuthHeaderName": "",
      "CustomAuthHeaderValue": ""
    }
  }
}
```

SendEvent:

```json
{
  "SiteID": "",
  "ServiceEndpoint": ""
}
```

DiscoverEvent:

```json
{
  "ApiKey": "",
  "ClientID": "",
  "ServiceEndpoint": ""
}
```

Mailchimp:

```json
{
  "ApiKey": ""
}
```

AWS S3:

```json
{
  "AccessKeyId": "",
  "SecretAccessKey": "",
  "SystemName": "",
  "OverrideBucketName": "",
  "StreamEvents": true
}
```

## Management endpoints

Available operations:

- `GET integrations/deliveryconfig`
- `GET integrations/deliveryconfig/{deliveryConfigId}`
- `POST integrations/deliveryconfig`
- `PUT integrations/deliveryconfig/{deliveryConfigId}`
- `PATCH integrations/deliveryconfig/{deliveryConfigId}`
- `DELETE integrations/deliveryconfig/{deliveryConfigId}`

## Implementation details

### Event types

| Namespace | Description |
| --- | --- |
| [sitecore.ordercloud.messages.product.updated](https://doc.sitecore.com/ordercloud/en/developers/platform/reference/delivery-config/product-updated-message.html) | Sent when a product has been created or updated. |
| [sitecore.ordercloud.messages.product.deleted](https://doc.sitecore.com/ordercloud/en/developers/platform/reference/delivery-config/product-deleted-message.html) | Sent when a product is deleted. |
| [sitecore.ordercloud.messages.orders.lines.added](https://doc.sitecore.com/ordercloud/en/developers/platform/reference/delivery-config/orderline-added-updated-message.html) | Sent when a line item is added to an order. |
| [sitecore.ordercloud.messages.orders.lines.updated](https://doc.sitecore.com/ordercloud/en/developers/platform/reference/delivery-config/orderline-added-updated-message.html) | Sent when a line item is updated in an order. |
| [sitecore.ordercloud.messages.orders.submitted](https://doc.sitecore.com/ordercloud/en/developers/platform/reference/delivery-config/order-submitted-message.html) | Sent when an order is submitted. |
| [sitecore.ordercloud.messages.sessions.identified](https://doc.sitecore.com/ordercloud/en/developers/platform/reference/delivery-config/session-identified-message.html) | Sent when a user logs in and has been identified. |
| [sitecore.ordercloud.messages.ordersync.updated](https://doc.sitecore.com/ordercloud/en/developers/platform/reference/delivery-config/ordersync-updated-message.html) | Sent when an order is updated and OrderSync has been enabled. |
| [sitecore.ordercloud.messages.ordersync.deleted](https://doc.sitecore.com/ordercloud/en/developers/platform/reference/delivery-config/ordersync-deleted-message.html) | Sent when an order is deleted and OrderSync has been enabled. |
| [sitecore.ordercloud.messages.entitysync.category.updated](https://doc.sitecore.com/ordercloud/en/developers/platform/reference/delivery-config/entitysync-category-updated-message.html) | Sent with a category has been updated. |
| [sitecore.ordercloud.messages.entitysync.category.deleted](https://doc.sitecore.com/ordercloud/en/developers/platform/reference/delivery-config/entitysync-category-deleted-message.html) | Sent when a category is deleted. |
| [sitecore.ordercloud.messages.entitysync.adminuser.updated](https://doc.sitecore.com/ordercloud/en/developers/platform/reference/delivery-config/entitysync-user-updated-message.html) | Sent when an admin user is updated. |
| [sitecore.ordercloud.messages.entitysync.adminuser.deleted](https://doc.sitecore.com/ordercloud/en/developers/platform/reference/delivery-config/entitysync-model-deleted-message.html) | Sent when an admin user is deleted. |
| [sitecore.ordercloud.messages.entitysync.buyer.deleted](https://doc.sitecore.com/ordercloud/en/developers/platform/reference/delivery-config/entitysync-model-deleted-message.html) | Sent when a buyer is deleted. |
| [sitecore.ordercloud.messages.entitysync.buyer.updated](https://doc.sitecore.com/ordercloud/en/developers/platform/reference/delivery-config/entitysync-buyer-updated-message.html) | Sent when a buyer is updated. |
| [sitecore.ordercloud.messages.entitysync.buyerusergroup.deleted](https://doc.sitecore.com/ordercloud/en/developers/platform/reference/delivery-config/entitysync-usergroup-deleted-message.html) | Sent when a buyer user group is deleted. |
| [sitecore.ordercloud.messages.entitysync.buyerusergroup.updated](https://doc.sitecore.com/ordercloud/en/developers/platform/reference/delivery-config/entitysync-usergroup-updated-message.html) | Sent when a buyer user group is updated. |
| [sitecore.ordercloud.messages.entitysync.buyeruser.updated](https://doc.sitecore.com/ordercloud/en/developers/platform/reference/delivery-config/entitysync-user-updated-message.html) | Sent when a buyer user is updated. |
| [sitecore.ordercloud.messages.entitysync.buyeruser.deleted](https://doc.sitecore.com/ordercloud/en/developers/platform/reference/delivery-config/entitysync-model-deleted-message.html) | Sent when a buyer user is deleted. |
| [sitecore.ordercloud.messages.entitysync.inventoryrecord.updated](https://doc.sitecore.com/ordercloud/en/developers/platform/reference/delivery-config/entitysync-inventoryrecord-updated-message.html) | Sent when a single inventory record has been changed. |
| [sitecore.ordercloud.messages.entitysync.inventoryrecord.deleted](https://doc.sitecore.com/ordercloud/en/developers/platform/reference/delivery-config/entitysync-inventoryrecord-deleted-message.html) | Sent when an inventory record has been deleted. |
| [sitecore.ordercloud.messages.entitysync.inventoryrecord.full.updated](https://doc.sitecore.com/ordercloud/en/developers/platform/reference/delivery-config/entitysync-inventoryrecord-updated-message.html) | Sent when a full inventory record sync has been initiated. |
| [sitecore.ordercloud.messages.entitysync.supplieruser.updated](https://doc.sitecore.com/ordercloud/en/developers/platform/reference/delivery-config/entitysync-user-updated-message.html) | Sent when a supplier user is updated. |
| [sitecore.ordercloud.messages.entitysync.supplieruser.deleted](https://doc.sitecore.com/ordercloud/en/developers/platform/reference/delivery-config/entitysync-model-deleted-message.html) | Sent when a supplier user is updated. |
| [sitecore.ordercloud.messages.entitysync.supplier.updated](https://doc.sitecore.com/ordercloud/en/developers/platform/reference/delivery-config/entitysync-supplier-updated-message.html) | Sent when a supplier is updated. |
| [sitecore.ordercloud.messages.entitysync.supplier.deleted](https://doc.sitecore.com/ordercloud/en/developers/platform/reference/delivery-config/entitysync-supplier-deleted-message.html) | Sent when a supplier is deleted. |
| sitecore.ordercloud.messages.messagesender.{MessageType} | Send when a message sender is triggered. Represents one of the message types defined in the [Message Sender](https://doc.sitecore.com/ordercloud/en/developers/platform/message-senders.html#message-sender-types) documentation. |


### Payload structures

HTTP format:

```json
{
  "Headers": {
    "type": "<value>"
  },
  "ConfigData": {},
  "Payload": {}
}
```

Additional headers:

- X-oc-hash: Webhook verification hash

EventHub properties:

- type
- sitecoreorg
- marketplace
- tenant

Kafka properties:

- ce_type
- ce_sitecoreorg
- ce_marketplace
- ce_tenant

### Storage containers

| Container | Purpose |
| ----------- | ---------- |
| entitysync | Entity synchronization |
| logs | Error configuration |
| orders | Order synchronization |
| products | Product synchronization |
| trackingevents | Event tracking |
| webhooks | Webhook delivery |

## Related reading

- [Error configuration](https://doc.sitecore.com/ordercloud/en/developers/platform/errorconfig.html)
- [Configuring custom password security](https://doc.sitecore.com/ordercloud/en/developers/platform/custom-password-configuration.html)


