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

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

DeliveryTargets options

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

Integration configurations

Kafka settings

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

HTTP configuration

{
  "Endpoint": "",
  "Secret": ""
}

Note: Secret enables webhook verification

EventHub settings

{
  "ConnectionString": "",
  "EventHubName": ""
}

Azure storage options

Blob storage:

{
  "ConnectionString": "",
  "OverrideContainerName": ""
}

Table storage:

{
  "ConnectionString": "",
  "OverrideTableName": ""
}

Database configurations

CosmosDB:

{
  "ConnectionString": "",
  "OverrideDatabaseName": ""
}

Messaging settings

MessageSender:

{
  "Secret": "",
  "EndPoint": ""
}

Integration APIs

SearchIngestion:

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

SendEvent:

{
  "SiteID": "",
  "ServiceEndpoint": ""
}

DiscoverEvent:

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

Mailchimp:

{
  "ApiKey": ""
}

AWS S3:

{
  "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

Payload structures

HTTP format:

{
  "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

Related reading

• Error configuration
• Configuring custom password security
• Configuring user and application data access