Creates or updates an integration configuration

POST 
/v1/management/integration

Creates or updates an integration configuration

Request

Header Parameters

companyId string

application/json-patch+json; x-api-version=1.0

Body

pollingIntervalInSeconds int32
intervalExpression stringnullable
stopOnEncodingError boolean
removeBom boolean
messageInboundEncoding stringrequired

Possible values: non-empty

messageInboundFormat stringrequired

Possible values: non-empty

receiver stringrequired

Possible values: non-empty

sender stringrequired

Possible values: non-empty

retryOptions

object

failureCountIntervalMinutes int32nullable

reQueueMaxDelaySeconds int32nullable

reQueueMinDelaySeconds int32nullable

maxErrorsPerInterval int32nullable

numberOfRetries int32nullable

enabled boolean

turnOffErrorPersistance boolean

maxDelayActions int32nullable

inboundRetryOptions

object

failureRetryIntervalSeconds int32nullable

turnOffFailureRetry boolean

retryOnNonTransientFailures boolean

loggingWebhooks

object[]

nullable

Array [

contract int32

Possible values: [0, 1]

endpointURL stringnullable

httpVerb stringnullable

webhookConnectionId stringnullable

adapterType int32

Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]

queryString stringnullable

maxRetries int32

timeout int32

authorizationHeaderKey

object

decryptedValue stringnullable

name stringnullable

version stringnullable

type int32

Possible values: [0, 1, 2, 3, 4, 5]

enabled boolean

headers

object

nullable

property name* string

logLevel int32

Possible values: [0, 1, 2, 3, 4]

inboundMesssageType stringnullable

outboundMessageType stringnullable

logMessageContent booleannullable

transactionTag stringnullable

customInboundDescription stringnullable

customOutboundDescription stringnullable

logMetaData booleannullable

useExternalContentService booleannullable

sendContentOnExternalServiceFailure booleannullable

externalContentServiceWebhook

object

endpointURL stringnullable

httpVerb stringnullable

webhookConnectionId stringnullable

authorizationHeaderType stringnullable

apimSubscriptionKey

object

decryptedValue stringnullable

name stringnullable

version stringnullable

oAuthUrl stringnullable

oAuthBody stringnullable

oAuthClientId stringnullable

oAuthClientSecret

object

decryptedValue stringnullable

name stringnullable

version stringnullable

headers

object

nullable

property name* string

body stringnullable

usePaging boolean

useDateDelta boolean

pagingType int32

Possible values: [0, 1]

nextLinkType int32

Possible values: [0, 1]

pathName stringnullable

oAuthGrantType stringnullable

oAuthUserName stringnullable

oAuthPwd

object

decryptedValue stringnullable

name stringnullable

version stringnullable

oAuthResource stringnullable

oAuthScope stringnullable

customAuthenticationProperties

object

nullable

property name* string

basicAuthenticationUserName stringnullable

basicAuthenticationPassword

object

decryptedValue stringnullable

name stringnullable

version stringnullable

newInternalMessageCorrelationId stringnullable

newInternalMessagePreserveInterchangeId boolean

useFallBackOnRequestFailed boolean

fallBackOnThreeHoundred boolean

fallBackOnFourHoundred boolean

fallBackOnFiveHoundred boolean

restConnectionPropertiesSecondary

useStaticIp boolean

terminateOnDuplicateDetection boolean

duplicateTerminationStatus stringnullable

restResponseErrorHandlingRules

object[]

nullable

Array [

statusCodes stringnullable

action int32

Possible values: [0, 1, 2]

retry boolean

customStatus stringnullable

]

customTimeout int32

useCustomTokenHeader booleannullable

customTokenHeader

object

key stringnullable

value stringnullable

]

transactionType stringrequired

Possible values: non-empty

subscriptionId uuidrequired

subIntegrations

object[]

required

Possible values: >= 1

Array [

subIntegrationId uuidrequired

subintegrationName stringnullable

receiver stringnullable

loggingWebhookOverrides

object

logLevel int32

Possible values: [0, 1, 2, 3, 4]

inboundMesssageType stringnullable

outboundMessageType stringnullable

logMessageContent booleannullable

transactionTag stringnullable

customInboundDescription stringnullable

customOutboundDescription stringnullable

logMetaData booleannullable

enabled boolean

transformations

object[]

nullable

Array [

transformationType stringrequired

Possible values: non-empty

transformationName stringnullable

properties stringrequired

Possible values: non-empty

]

passThrough boolean

outboundConnections

object[]

required

Possible values: >= 1

Array [

adapterType stringrequired

Possible values: non-empty

adapterId stringnullable

adapterName stringnullable

connectionProperties stringnullable

ackOptions

object

sendAck boolean

adapterType stringnullable

connectionProperties stringnullable

transformationSasUri stringnullable

transformationId stringnullable

transformationVersion stringnullable

ackOutboundFormat stringnullable

sendNegativeAck boolean

]

messageOutboundFormat stringrequired

Possible values: non-empty

messageOutboundEncoding stringnullable

preDefinedUserProperties

object

nullable

property name* string

enabled boolean

]

inboundConnection

object

required

adapterType stringrequired

Possible values: non-empty

adapterId stringnullable

adapterName stringnullable

connectionProperties stringnullable

ackOptions

object

sendAck boolean

adapterType stringnullable

connectionProperties stringnullable

transformationSasUri stringnullable

transformationId stringnullable

transformationVersion stringnullable

ackOutboundFormat stringnullable

sendNegativeAck boolean
description stringnullable
configCorrelationId uuidnullable

resendWebhooks

object[]

nullable

Array [

contract int32

Possible values: [0, 1]

endpointURL stringnullable

httpVerb stringnullable

webhookConnectionId stringnullable

adapterType int32

Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]

queryString stringnullable

maxRetries int32

timeout int32

authorizationHeaderKey

object

decryptedValue stringnullable

name stringnullable

version stringnullable

type int32

Possible values: [0, 1, 2, 3, 4, 5]

enabled boolean

headers

object

nullable

property name* string

usePureMessageSending boolean

]

enabled boolean

application/json; x-api-version=1.0

Body

pollingIntervalInSeconds int32
intervalExpression stringnullable
stopOnEncodingError boolean
removeBom boolean
messageInboundEncoding stringrequired

Possible values: non-empty

messageInboundFormat stringrequired

Possible values: non-empty

receiver stringrequired

Possible values: non-empty

sender stringrequired

Possible values: non-empty

retryOptions

object

failureCountIntervalMinutes int32nullable

reQueueMaxDelaySeconds int32nullable

reQueueMinDelaySeconds int32nullable

maxErrorsPerInterval int32nullable

numberOfRetries int32nullable

enabled boolean

turnOffErrorPersistance boolean

maxDelayActions int32nullable

inboundRetryOptions

object

failureRetryIntervalSeconds int32nullable

turnOffFailureRetry boolean

retryOnNonTransientFailures boolean

loggingWebhooks

object[]

nullable

Array [

contract int32

Possible values: [0, 1]

endpointURL stringnullable

httpVerb stringnullable

webhookConnectionId stringnullable

adapterType int32

Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]

queryString stringnullable

maxRetries int32

timeout int32

authorizationHeaderKey

object

decryptedValue stringnullable

name stringnullable

version stringnullable

type int32

Possible values: [0, 1, 2, 3, 4, 5]

enabled boolean

headers

object

nullable

property name* string

logLevel int32

Possible values: [0, 1, 2, 3, 4]

inboundMesssageType stringnullable

outboundMessageType stringnullable

logMessageContent booleannullable

transactionTag stringnullable

customInboundDescription stringnullable

customOutboundDescription stringnullable

logMetaData booleannullable

useExternalContentService booleannullable

sendContentOnExternalServiceFailure booleannullable

externalContentServiceWebhook

object

endpointURL stringnullable

httpVerb stringnullable

webhookConnectionId stringnullable

authorizationHeaderType stringnullable

apimSubscriptionKey

object

decryptedValue stringnullable

name stringnullable

version stringnullable

oAuthUrl stringnullable

oAuthBody stringnullable

oAuthClientId stringnullable

oAuthClientSecret

object

decryptedValue stringnullable

name stringnullable

version stringnullable

headers

object

nullable

property name* string

body stringnullable

usePaging boolean

useDateDelta boolean

pagingType int32

Possible values: [0, 1]

nextLinkType int32

Possible values: [0, 1]

pathName stringnullable

oAuthGrantType stringnullable

oAuthUserName stringnullable

oAuthPwd

object

decryptedValue stringnullable

name stringnullable

version stringnullable

oAuthResource stringnullable

oAuthScope stringnullable

customAuthenticationProperties

object

nullable

property name* string

basicAuthenticationUserName stringnullable

basicAuthenticationPassword

object

decryptedValue stringnullable

name stringnullable

version stringnullable

newInternalMessageCorrelationId stringnullable

newInternalMessagePreserveInterchangeId boolean

useFallBackOnRequestFailed boolean

fallBackOnThreeHoundred boolean

fallBackOnFourHoundred boolean

fallBackOnFiveHoundred boolean

restConnectionPropertiesSecondary

useStaticIp boolean

terminateOnDuplicateDetection boolean

duplicateTerminationStatus stringnullable

restResponseErrorHandlingRules

object[]

nullable

Array [

statusCodes stringnullable

action int32

Possible values: [0, 1, 2]

retry boolean

customStatus stringnullable

]

customTimeout int32

useCustomTokenHeader booleannullable

customTokenHeader

object

key stringnullable

value stringnullable

]

transactionType stringrequired

Possible values: non-empty

subscriptionId uuidrequired

subIntegrations

object[]

required

Possible values: >= 1

Array [

subIntegrationId uuidrequired

subintegrationName stringnullable

receiver stringnullable

loggingWebhookOverrides

object

logLevel int32

Possible values: [0, 1, 2, 3, 4]

inboundMesssageType stringnullable

outboundMessageType stringnullable

logMessageContent booleannullable

transactionTag stringnullable

customInboundDescription stringnullable

customOutboundDescription stringnullable

logMetaData booleannullable

enabled boolean

transformations

object[]

nullable

Array [

transformationType stringrequired

Possible values: non-empty

transformationName stringnullable

properties stringrequired

Possible values: non-empty

]

passThrough boolean

outboundConnections

object[]

required

Possible values: >= 1

Array [

adapterType stringrequired

Possible values: non-empty

adapterId stringnullable

adapterName stringnullable

connectionProperties stringnullable

ackOptions

object

sendAck boolean

adapterType stringnullable

connectionProperties stringnullable

transformationSasUri stringnullable

transformationId stringnullable

transformationVersion stringnullable

ackOutboundFormat stringnullable

sendNegativeAck boolean

]

messageOutboundFormat stringrequired

Possible values: non-empty

messageOutboundEncoding stringnullable

preDefinedUserProperties

object

nullable

property name* string

enabled boolean

]

inboundConnection

object

required

adapterType stringrequired

Possible values: non-empty

adapterId stringnullable

adapterName stringnullable

connectionProperties stringnullable

ackOptions

object

sendAck boolean

adapterType stringnullable

connectionProperties stringnullable

transformationSasUri stringnullable

transformationId stringnullable

transformationVersion stringnullable

ackOutboundFormat stringnullable

sendNegativeAck boolean
description stringnullable
configCorrelationId uuidnullable

resendWebhooks

object[]

nullable

Array [

contract int32

Possible values: [0, 1]

endpointURL stringnullable

httpVerb stringnullable

webhookConnectionId stringnullable

adapterType int32

Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]

queryString stringnullable

maxRetries int32

timeout int32

authorizationHeaderKey

object

decryptedValue stringnullable

name stringnullable

version stringnullable

type int32

Possible values: [0, 1, 2, 3, 4, 5]

enabled boolean

headers

object

nullable

property name* string

usePureMessageSending boolean

]

enabled boolean

text/json; x-api-version=1.0

Body

pollingIntervalInSeconds int32
intervalExpression stringnullable
stopOnEncodingError boolean
removeBom boolean
messageInboundEncoding stringrequired

Possible values: non-empty

messageInboundFormat stringrequired

Possible values: non-empty

receiver stringrequired

Possible values: non-empty

sender stringrequired

Possible values: non-empty

retryOptions

object

failureCountIntervalMinutes int32nullable

reQueueMaxDelaySeconds int32nullable

reQueueMinDelaySeconds int32nullable

maxErrorsPerInterval int32nullable

numberOfRetries int32nullable

enabled boolean

turnOffErrorPersistance boolean

maxDelayActions int32nullable

inboundRetryOptions

object

failureRetryIntervalSeconds int32nullable

turnOffFailureRetry boolean

retryOnNonTransientFailures boolean

loggingWebhooks

object[]

nullable

Array [

contract int32

Possible values: [0, 1]

endpointURL stringnullable

httpVerb stringnullable

webhookConnectionId stringnullable

adapterType int32

Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]

queryString stringnullable

maxRetries int32

timeout int32

authorizationHeaderKey

object

decryptedValue stringnullable

name stringnullable

version stringnullable

type int32

Possible values: [0, 1, 2, 3, 4, 5]

enabled boolean

headers

object

nullable

property name* string

logLevel int32

Possible values: [0, 1, 2, 3, 4]

inboundMesssageType stringnullable

outboundMessageType stringnullable

logMessageContent booleannullable

transactionTag stringnullable

customInboundDescription stringnullable

customOutboundDescription stringnullable

logMetaData booleannullable

useExternalContentService booleannullable

sendContentOnExternalServiceFailure booleannullable

externalContentServiceWebhook

object

endpointURL stringnullable

httpVerb stringnullable

webhookConnectionId stringnullable

authorizationHeaderType stringnullable

apimSubscriptionKey

object

decryptedValue stringnullable

name stringnullable

version stringnullable

oAuthUrl stringnullable

oAuthBody stringnullable

oAuthClientId stringnullable

oAuthClientSecret

object

decryptedValue stringnullable

name stringnullable

version stringnullable

headers

object

nullable

property name* string

body stringnullable

usePaging boolean

useDateDelta boolean

pagingType int32

Possible values: [0, 1]

nextLinkType int32

Possible values: [0, 1]

pathName stringnullable

oAuthGrantType stringnullable

oAuthUserName stringnullable

oAuthPwd

object

decryptedValue stringnullable

name stringnullable

version stringnullable

oAuthResource stringnullable

oAuthScope stringnullable

customAuthenticationProperties

object

nullable

property name* string

basicAuthenticationUserName stringnullable

basicAuthenticationPassword

object

decryptedValue stringnullable

name stringnullable

version stringnullable

newInternalMessageCorrelationId stringnullable

newInternalMessagePreserveInterchangeId boolean

useFallBackOnRequestFailed boolean

fallBackOnThreeHoundred boolean

fallBackOnFourHoundred boolean

fallBackOnFiveHoundred boolean

restConnectionPropertiesSecondary

useStaticIp boolean

terminateOnDuplicateDetection boolean

duplicateTerminationStatus stringnullable

restResponseErrorHandlingRules

object[]

nullable

Array [

statusCodes stringnullable

action int32

Possible values: [0, 1, 2]

retry boolean

customStatus stringnullable

]

customTimeout int32

useCustomTokenHeader booleannullable

customTokenHeader

object

key stringnullable

value stringnullable

]

transactionType stringrequired

Possible values: non-empty

subscriptionId uuidrequired

subIntegrations

object[]

required

Possible values: >= 1

Array [

subIntegrationId uuidrequired

subintegrationName stringnullable

receiver stringnullable

loggingWebhookOverrides

object

logLevel int32

Possible values: [0, 1, 2, 3, 4]

inboundMesssageType stringnullable

outboundMessageType stringnullable

logMessageContent booleannullable

transactionTag stringnullable

customInboundDescription stringnullable

customOutboundDescription stringnullable

logMetaData booleannullable

enabled boolean

transformations

object[]

nullable

Array [

transformationType stringrequired

Possible values: non-empty

transformationName stringnullable

properties stringrequired

Possible values: non-empty

]

passThrough boolean

outboundConnections

object[]

required

Possible values: >= 1

Array [

adapterType stringrequired

Possible values: non-empty

adapterId stringnullable

adapterName stringnullable

connectionProperties stringnullable

ackOptions

object

sendAck boolean

adapterType stringnullable

connectionProperties stringnullable

transformationSasUri stringnullable

transformationId stringnullable

transformationVersion stringnullable

ackOutboundFormat stringnullable

sendNegativeAck boolean

]

messageOutboundFormat stringrequired

Possible values: non-empty

messageOutboundEncoding stringnullable

preDefinedUserProperties

object

nullable

property name* string

enabled boolean

]

inboundConnection

object

required

adapterType stringrequired

Possible values: non-empty

adapterId stringnullable

adapterName stringnullable

connectionProperties stringnullable

ackOptions

object

sendAck boolean

adapterType stringnullable

connectionProperties stringnullable

transformationSasUri stringnullable

transformationId stringnullable

transformationVersion stringnullable

ackOutboundFormat stringnullable

sendNegativeAck boolean
description stringnullable
configCorrelationId uuidnullable

resendWebhooks

object[]

nullable

Array [

contract int32

Possible values: [0, 1]

endpointURL stringnullable

httpVerb stringnullable

webhookConnectionId stringnullable

adapterType int32

Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]

queryString stringnullable

maxRetries int32

timeout int32

authorizationHeaderKey

object

decryptedValue stringnullable

name stringnullable

version stringnullable

type int32

Possible values: [0, 1, 2, 3, 4, 5]

enabled boolean

headers

object

nullable

property name* string

usePureMessageSending boolean

]

enabled boolean

application/*+json; x-api-version=1.0

Body

pollingIntervalInSeconds int32
intervalExpression stringnullable
stopOnEncodingError boolean
removeBom boolean
messageInboundEncoding stringrequired

Possible values: non-empty

messageInboundFormat stringrequired

Possible values: non-empty

receiver stringrequired

Possible values: non-empty

sender stringrequired

Possible values: non-empty

retryOptions

object

failureCountIntervalMinutes int32nullable

reQueueMaxDelaySeconds int32nullable

reQueueMinDelaySeconds int32nullable

maxErrorsPerInterval int32nullable

numberOfRetries int32nullable

enabled boolean

turnOffErrorPersistance boolean

maxDelayActions int32nullable

inboundRetryOptions

object

failureRetryIntervalSeconds int32nullable

turnOffFailureRetry boolean

retryOnNonTransientFailures boolean

loggingWebhooks

object[]

nullable

Array [

contract int32

Possible values: [0, 1]

endpointURL stringnullable

httpVerb stringnullable

webhookConnectionId stringnullable

adapterType int32

Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]

queryString stringnullable

maxRetries int32

timeout int32

authorizationHeaderKey

object

decryptedValue stringnullable

name stringnullable

version stringnullable

type int32

Possible values: [0, 1, 2, 3, 4, 5]

enabled boolean

headers

object

nullable

property name* string

logLevel int32

Possible values: [0, 1, 2, 3, 4]

inboundMesssageType stringnullable

outboundMessageType stringnullable

logMessageContent booleannullable

transactionTag stringnullable

customInboundDescription stringnullable

customOutboundDescription stringnullable

logMetaData booleannullable

useExternalContentService booleannullable

sendContentOnExternalServiceFailure booleannullable

externalContentServiceWebhook

object

endpointURL stringnullable

httpVerb stringnullable

webhookConnectionId stringnullable

authorizationHeaderType stringnullable

apimSubscriptionKey

object

decryptedValue stringnullable

name stringnullable

version stringnullable

oAuthUrl stringnullable

oAuthBody stringnullable

oAuthClientId stringnullable

oAuthClientSecret

object

decryptedValue stringnullable

name stringnullable

version stringnullable

headers

object

nullable

property name* string

body stringnullable

usePaging boolean

useDateDelta boolean

pagingType int32

Possible values: [0, 1]

nextLinkType int32

Possible values: [0, 1]

pathName stringnullable

oAuthGrantType stringnullable

oAuthUserName stringnullable

oAuthPwd

object

decryptedValue stringnullable

name stringnullable

version stringnullable

oAuthResource stringnullable

oAuthScope stringnullable

customAuthenticationProperties

object

nullable

property name* string

basicAuthenticationUserName stringnullable

basicAuthenticationPassword

object

decryptedValue stringnullable

name stringnullable

version stringnullable

newInternalMessageCorrelationId stringnullable

newInternalMessagePreserveInterchangeId boolean

useFallBackOnRequestFailed boolean

fallBackOnThreeHoundred boolean

fallBackOnFourHoundred boolean

fallBackOnFiveHoundred boolean

restConnectionPropertiesSecondary

useStaticIp boolean

terminateOnDuplicateDetection boolean

duplicateTerminationStatus stringnullable

restResponseErrorHandlingRules

object[]

nullable

Array [

statusCodes stringnullable

action int32

Possible values: [0, 1, 2]

retry boolean

customStatus stringnullable

]

customTimeout int32

useCustomTokenHeader booleannullable

customTokenHeader

object

key stringnullable

value stringnullable

]

transactionType stringrequired

Possible values: non-empty

subscriptionId uuidrequired

subIntegrations

object[]

required

Possible values: >= 1

Array [

subIntegrationId uuidrequired

subintegrationName stringnullable

receiver stringnullable

loggingWebhookOverrides

object

logLevel int32

Possible values: [0, 1, 2, 3, 4]

inboundMesssageType stringnullable

outboundMessageType stringnullable

logMessageContent booleannullable

transactionTag stringnullable

customInboundDescription stringnullable

customOutboundDescription stringnullable

logMetaData booleannullable

enabled boolean

transformations

object[]

nullable

Array [

transformationType stringrequired

Possible values: non-empty

transformationName stringnullable

properties stringrequired

Possible values: non-empty

]

passThrough boolean

outboundConnections

object[]

required

Possible values: >= 1

Array [

adapterType stringrequired

Possible values: non-empty

adapterId stringnullable

adapterName stringnullable

connectionProperties stringnullable

ackOptions

object

sendAck boolean

adapterType stringnullable

connectionProperties stringnullable

transformationSasUri stringnullable

transformationId stringnullable

transformationVersion stringnullable

ackOutboundFormat stringnullable

sendNegativeAck boolean

]

messageOutboundFormat stringrequired

Possible values: non-empty

messageOutboundEncoding stringnullable

preDefinedUserProperties

object

nullable

property name* string

enabled boolean

]

inboundConnection

object

required

adapterType stringrequired

Possible values: non-empty

adapterId stringnullable

adapterName stringnullable

connectionProperties stringnullable

ackOptions

object

sendAck boolean

adapterType stringnullable

connectionProperties stringnullable

transformationSasUri stringnullable

transformationId stringnullable

transformationVersion stringnullable

ackOutboundFormat stringnullable

sendNegativeAck boolean
description stringnullable
configCorrelationId uuidnullable

resendWebhooks

object[]

nullable

Array [

contract int32

Possible values: [0, 1]

endpointURL stringnullable

httpVerb stringnullable

webhookConnectionId stringnullable

adapterType int32

Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]

queryString stringnullable

maxRetries int32

timeout int32

authorizationHeaderKey

object

decryptedValue stringnullable

name stringnullable

version stringnullable

type int32

Possible values: [0, 1, 2, 3, 4, 5]

enabled boolean

headers

object

nullable

property name* string

usePureMessageSending boolean

]

enabled boolean

application/xml; x-api-version=1.0

Body

pollingIntervalInSeconds int32
intervalExpression stringnullable
stopOnEncodingError boolean
removeBom boolean
messageInboundEncoding stringrequired

Possible values: non-empty

messageInboundFormat stringrequired

Possible values: non-empty

receiver stringrequired

Possible values: non-empty

sender stringrequired

Possible values: non-empty

retryOptions

object

failureCountIntervalMinutes int32nullable

reQueueMaxDelaySeconds int32nullable

reQueueMinDelaySeconds int32nullable

maxErrorsPerInterval int32nullable

numberOfRetries int32nullable

enabled boolean

turnOffErrorPersistance boolean

maxDelayActions int32nullable

inboundRetryOptions

object

failureRetryIntervalSeconds int32nullable

turnOffFailureRetry boolean

retryOnNonTransientFailures boolean

loggingWebhooks

object[]

nullable

Array [

contract int32

Possible values: [0, 1]

endpointURL stringnullable

httpVerb stringnullable

webhookConnectionId stringnullable

adapterType int32

Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]

queryString stringnullable

maxRetries int32

timeout int32

authorizationHeaderKey

object

decryptedValue stringnullable

name stringnullable

version stringnullable

type int32

Possible values: [0, 1, 2, 3, 4, 5]

enabled boolean

headers

object

nullable

property name* string

logLevel int32

Possible values: [0, 1, 2, 3, 4]

inboundMesssageType stringnullable

outboundMessageType stringnullable

logMessageContent booleannullable

transactionTag stringnullable

customInboundDescription stringnullable

customOutboundDescription stringnullable

logMetaData booleannullable

useExternalContentService booleannullable

sendContentOnExternalServiceFailure booleannullable

externalContentServiceWebhook

object

endpointURL stringnullable

httpVerb stringnullable

webhookConnectionId stringnullable

authorizationHeaderType stringnullable

apimSubscriptionKey

object

decryptedValue stringnullable

name stringnullable

version stringnullable

oAuthUrl stringnullable

oAuthBody stringnullable

oAuthClientId stringnullable

oAuthClientSecret

object

decryptedValue stringnullable

name stringnullable

version stringnullable

headers

object

nullable

property name* string

body stringnullable

usePaging boolean

useDateDelta boolean

pagingType int32

Possible values: [0, 1]

nextLinkType int32

Possible values: [0, 1]

pathName stringnullable

oAuthGrantType stringnullable

oAuthUserName stringnullable

oAuthPwd

object

decryptedValue stringnullable

name stringnullable

version stringnullable

oAuthResource stringnullable

oAuthScope stringnullable

customAuthenticationProperties

object

nullable

property name* string

basicAuthenticationUserName stringnullable

basicAuthenticationPassword

object

decryptedValue stringnullable

name stringnullable

version stringnullable

newInternalMessageCorrelationId stringnullable

newInternalMessagePreserveInterchangeId boolean

useFallBackOnRequestFailed boolean

fallBackOnThreeHoundred boolean

fallBackOnFourHoundred boolean

fallBackOnFiveHoundred boolean

restConnectionPropertiesSecondary

useStaticIp boolean

terminateOnDuplicateDetection boolean

duplicateTerminationStatus stringnullable

restResponseErrorHandlingRules

object[]

nullable

Array [

statusCodes stringnullable

action int32

Possible values: [0, 1, 2]

retry boolean

customStatus stringnullable

]

customTimeout int32

useCustomTokenHeader booleannullable

customTokenHeader

object

key stringnullable

value stringnullable

]

transactionType stringrequired

Possible values: non-empty

subscriptionId uuidrequired

subIntegrations

object[]

required

Possible values: >= 1

Array [

subIntegrationId uuidrequired

subintegrationName stringnullable

receiver stringnullable

loggingWebhookOverrides

object

logLevel int32

Possible values: [0, 1, 2, 3, 4]

inboundMesssageType stringnullable

outboundMessageType stringnullable

logMessageContent booleannullable

transactionTag stringnullable

customInboundDescription stringnullable

customOutboundDescription stringnullable

logMetaData booleannullable

enabled boolean

transformations

object[]

nullable

Array [

transformationType stringrequired

Possible values: non-empty

transformationName stringnullable

properties stringrequired

Possible values: non-empty

]

passThrough boolean

outboundConnections

object[]

required

Possible values: >= 1

Array [

adapterType stringrequired

Possible values: non-empty

adapterId stringnullable

adapterName stringnullable

connectionProperties stringnullable

ackOptions

object

sendAck boolean

adapterType stringnullable

connectionProperties stringnullable

transformationSasUri stringnullable

transformationId stringnullable

transformationVersion stringnullable

ackOutboundFormat stringnullable

sendNegativeAck boolean

]

messageOutboundFormat stringrequired

Possible values: non-empty

messageOutboundEncoding stringnullable

preDefinedUserProperties

object

nullable

property name* string

enabled boolean

]

inboundConnection

object

required

adapterType stringrequired

Possible values: non-empty

adapterId stringnullable

adapterName stringnullable

connectionProperties stringnullable

ackOptions

object

sendAck boolean

adapterType stringnullable

connectionProperties stringnullable

transformationSasUri stringnullable

transformationId stringnullable

transformationVersion stringnullable

ackOutboundFormat stringnullable

sendNegativeAck boolean
description stringnullable
configCorrelationId uuidnullable

resendWebhooks

object[]

nullable

Array [

contract int32

Possible values: [0, 1]

endpointURL stringnullable

httpVerb stringnullable

webhookConnectionId stringnullable

adapterType int32

Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]

queryString stringnullable

maxRetries int32

timeout int32

authorizationHeaderKey

object

decryptedValue stringnullable

name stringnullable

version stringnullable

type int32

Possible values: [0, 1, 2, 3, 4, 5]

enabled boolean

headers

object

nullable

property name* string

usePureMessageSending boolean

]

enabled boolean

text/xml; x-api-version=1.0

Body

pollingIntervalInSeconds int32
intervalExpression stringnullable
stopOnEncodingError boolean
removeBom boolean
messageInboundEncoding stringrequired

Possible values: non-empty

messageInboundFormat stringrequired

Possible values: non-empty

receiver stringrequired

Possible values: non-empty

sender stringrequired

Possible values: non-empty

retryOptions

object

failureCountIntervalMinutes int32nullable

reQueueMaxDelaySeconds int32nullable

reQueueMinDelaySeconds int32nullable

maxErrorsPerInterval int32nullable

numberOfRetries int32nullable

enabled boolean

turnOffErrorPersistance boolean

maxDelayActions int32nullable

inboundRetryOptions

object

failureRetryIntervalSeconds int32nullable

turnOffFailureRetry boolean

retryOnNonTransientFailures boolean

loggingWebhooks

object[]

nullable

Array [

contract int32

Possible values: [0, 1]

endpointURL stringnullable

httpVerb stringnullable

webhookConnectionId stringnullable

adapterType int32

Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]

queryString stringnullable

maxRetries int32

timeout int32

authorizationHeaderKey

object

decryptedValue stringnullable

name stringnullable

version stringnullable

type int32

Possible values: [0, 1, 2, 3, 4, 5]

enabled boolean

headers

object

nullable

property name* string

logLevel int32

Possible values: [0, 1, 2, 3, 4]

inboundMesssageType stringnullable

outboundMessageType stringnullable

logMessageContent booleannullable

transactionTag stringnullable

customInboundDescription stringnullable

customOutboundDescription stringnullable

logMetaData booleannullable

useExternalContentService booleannullable

sendContentOnExternalServiceFailure booleannullable

externalContentServiceWebhook

object

endpointURL stringnullable

httpVerb stringnullable

webhookConnectionId stringnullable

authorizationHeaderType stringnullable

apimSubscriptionKey

object

decryptedValue stringnullable

name stringnullable

version stringnullable

oAuthUrl stringnullable

oAuthBody stringnullable

oAuthClientId stringnullable

oAuthClientSecret

object

decryptedValue stringnullable

name stringnullable

version stringnullable

headers

object

nullable

property name* string

body stringnullable

usePaging boolean

useDateDelta boolean

pagingType int32

Possible values: [0, 1]

nextLinkType int32

Possible values: [0, 1]

pathName stringnullable

oAuthGrantType stringnullable

oAuthUserName stringnullable

oAuthPwd

object

decryptedValue stringnullable

name stringnullable

version stringnullable

oAuthResource stringnullable

oAuthScope stringnullable

customAuthenticationProperties

object

nullable

property name* string

basicAuthenticationUserName stringnullable

basicAuthenticationPassword

object

decryptedValue stringnullable

name stringnullable

version stringnullable

newInternalMessageCorrelationId stringnullable

newInternalMessagePreserveInterchangeId boolean

useFallBackOnRequestFailed boolean

fallBackOnThreeHoundred boolean

fallBackOnFourHoundred boolean

fallBackOnFiveHoundred boolean

restConnectionPropertiesSecondary

useStaticIp boolean

terminateOnDuplicateDetection boolean

duplicateTerminationStatus stringnullable

restResponseErrorHandlingRules

object[]

nullable

Array [

statusCodes stringnullable

action int32

Possible values: [0, 1, 2]

retry boolean

customStatus stringnullable

]

customTimeout int32

useCustomTokenHeader booleannullable

customTokenHeader

object

key stringnullable

value stringnullable

]

transactionType stringrequired

Possible values: non-empty

subscriptionId uuidrequired

subIntegrations

object[]

required

Possible values: >= 1

Array [

subIntegrationId uuidrequired

subintegrationName stringnullable

receiver stringnullable

loggingWebhookOverrides

object

logLevel int32

Possible values: [0, 1, 2, 3, 4]

inboundMesssageType stringnullable

outboundMessageType stringnullable

logMessageContent booleannullable

transactionTag stringnullable

customInboundDescription stringnullable

customOutboundDescription stringnullable

logMetaData booleannullable

enabled boolean

transformations

object[]

nullable

Array [

transformationType stringrequired

Possible values: non-empty

transformationName stringnullable

properties stringrequired

Possible values: non-empty

]

passThrough boolean

outboundConnections

object[]

required

Possible values: >= 1

Array [

adapterType stringrequired

Possible values: non-empty

adapterId stringnullable

adapterName stringnullable

connectionProperties stringnullable

ackOptions

object

sendAck boolean

adapterType stringnullable

connectionProperties stringnullable

transformationSasUri stringnullable

transformationId stringnullable

transformationVersion stringnullable

ackOutboundFormat stringnullable

sendNegativeAck boolean

]

messageOutboundFormat stringrequired

Possible values: non-empty

messageOutboundEncoding stringnullable

preDefinedUserProperties

object

nullable

property name* string

enabled boolean

]

inboundConnection

object

required

adapterType stringrequired

Possible values: non-empty

adapterId stringnullable

adapterName stringnullable

connectionProperties stringnullable

ackOptions

object

sendAck boolean

adapterType stringnullable

connectionProperties stringnullable

transformationSasUri stringnullable

transformationId stringnullable

transformationVersion stringnullable

ackOutboundFormat stringnullable

sendNegativeAck boolean
description stringnullable
configCorrelationId uuidnullable

resendWebhooks

object[]

nullable

Array [

contract int32

Possible values: [0, 1]

endpointURL stringnullable

httpVerb stringnullable

webhookConnectionId stringnullable

adapterType int32

Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]

queryString stringnullable

maxRetries int32

timeout int32

authorizationHeaderKey

object

decryptedValue stringnullable

name stringnullable

version stringnullable

type int32

Possible values: [0, 1, 2, 3, 4, 5]

enabled boolean

headers

object

nullable

property name* string

usePureMessageSending boolean

]

enabled boolean

application/*+xml; x-api-version=1.0

Body

pollingIntervalInSeconds int32
intervalExpression stringnullable
stopOnEncodingError boolean
removeBom boolean
messageInboundEncoding stringrequired

Possible values: non-empty

messageInboundFormat stringrequired

Possible values: non-empty

receiver stringrequired

Possible values: non-empty

sender stringrequired

Possible values: non-empty

retryOptions

object

failureCountIntervalMinutes int32nullable

reQueueMaxDelaySeconds int32nullable

reQueueMinDelaySeconds int32nullable

maxErrorsPerInterval int32nullable

numberOfRetries int32nullable

enabled boolean

turnOffErrorPersistance boolean

maxDelayActions int32nullable

inboundRetryOptions

object

failureRetryIntervalSeconds int32nullable

turnOffFailureRetry boolean

retryOnNonTransientFailures boolean

loggingWebhooks

object[]

nullable

Array [

contract int32

Possible values: [0, 1]

endpointURL stringnullable

httpVerb stringnullable

webhookConnectionId stringnullable

adapterType int32

Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]

queryString stringnullable

maxRetries int32

timeout int32

authorizationHeaderKey

object

decryptedValue stringnullable

name stringnullable

version stringnullable

type int32

Possible values: [0, 1, 2, 3, 4, 5]

enabled boolean

headers

object

nullable

property name* string

logLevel int32

Possible values: [0, 1, 2, 3, 4]

inboundMesssageType stringnullable

outboundMessageType stringnullable

logMessageContent booleannullable

transactionTag stringnullable

customInboundDescription stringnullable

customOutboundDescription stringnullable

logMetaData booleannullable

useExternalContentService booleannullable

sendContentOnExternalServiceFailure booleannullable

externalContentServiceWebhook

object

endpointURL stringnullable

httpVerb stringnullable

webhookConnectionId stringnullable

authorizationHeaderType stringnullable

apimSubscriptionKey

object

decryptedValue stringnullable

name stringnullable

version stringnullable

oAuthUrl stringnullable

oAuthBody stringnullable

oAuthClientId stringnullable

oAuthClientSecret

object

decryptedValue stringnullable

name stringnullable

version stringnullable

headers

object

nullable

property name* string

body stringnullable

usePaging boolean

useDateDelta boolean

pagingType int32

Possible values: [0, 1]

nextLinkType int32

Possible values: [0, 1]

pathName stringnullable

oAuthGrantType stringnullable

oAuthUserName stringnullable

oAuthPwd

object

decryptedValue stringnullable

name stringnullable

version stringnullable

oAuthResource stringnullable

oAuthScope stringnullable

customAuthenticationProperties

object

nullable

property name* string

basicAuthenticationUserName stringnullable

basicAuthenticationPassword

object

decryptedValue stringnullable

name stringnullable

version stringnullable

newInternalMessageCorrelationId stringnullable

newInternalMessagePreserveInterchangeId boolean

useFallBackOnRequestFailed boolean

fallBackOnThreeHoundred boolean

fallBackOnFourHoundred boolean

fallBackOnFiveHoundred boolean

restConnectionPropertiesSecondary

useStaticIp boolean

terminateOnDuplicateDetection boolean

duplicateTerminationStatus stringnullable

restResponseErrorHandlingRules

object[]

nullable

Array [

statusCodes stringnullable

action int32

Possible values: [0, 1, 2]

retry boolean

customStatus stringnullable

]

customTimeout int32

useCustomTokenHeader booleannullable

customTokenHeader

object

key stringnullable

value stringnullable

]

transactionType stringrequired

Possible values: non-empty

subscriptionId uuidrequired

subIntegrations

object[]

required

Possible values: >= 1

Array [

subIntegrationId uuidrequired

subintegrationName stringnullable

receiver stringnullable

loggingWebhookOverrides

object

logLevel int32

Possible values: [0, 1, 2, 3, 4]

inboundMesssageType stringnullable

outboundMessageType stringnullable

logMessageContent booleannullable

transactionTag stringnullable

customInboundDescription stringnullable

customOutboundDescription stringnullable

logMetaData booleannullable

enabled boolean

transformations

object[]

nullable

Array [

transformationType stringrequired

Possible values: non-empty

transformationName stringnullable

properties stringrequired

Possible values: non-empty

]

passThrough boolean

outboundConnections

object[]

required

Possible values: >= 1

Array [

adapterType stringrequired

Possible values: non-empty

adapterId stringnullable

adapterName stringnullable

connectionProperties stringnullable

ackOptions

object

sendAck boolean

adapterType stringnullable

connectionProperties stringnullable

transformationSasUri stringnullable

transformationId stringnullable

transformationVersion stringnullable

ackOutboundFormat stringnullable

sendNegativeAck boolean

]

messageOutboundFormat stringrequired

Possible values: non-empty

messageOutboundEncoding stringnullable

preDefinedUserProperties

object

nullable

property name* string

enabled boolean

]

inboundConnection

object

required

adapterType stringrequired

Possible values: non-empty

adapterId stringnullable

adapterName stringnullable

connectionProperties stringnullable

ackOptions

object

sendAck boolean

adapterType stringnullable

connectionProperties stringnullable

transformationSasUri stringnullable

transformationId stringnullable

transformationVersion stringnullable

ackOutboundFormat stringnullable

sendNegativeAck boolean
description stringnullable
configCorrelationId uuidnullable

resendWebhooks

object[]

nullable

Array [

contract int32

Possible values: [0, 1]

endpointURL stringnullable

httpVerb stringnullable

webhookConnectionId stringnullable

adapterType int32

Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]

queryString stringnullable

maxRetries int32

timeout int32

authorizationHeaderKey

object

decryptedValue stringnullable

name stringnullable

version stringnullable

type int32

Possible values: [0, 1, 2, 3, 4, 5]

enabled boolean

headers

object

nullable

property name* string

usePureMessageSending boolean

]

enabled boolean

Responses

200

The updated integration configuration

text/plain; x-api-version=1.0

Schema

Schema

configCorrelationId stringnullable
description stringnullable

inboundConnection

object

adapterType stringnullable

useProcessLock boolean

wrapperType int32

Possible values: [0, 1, 2]

mightBeWrapped boolean

adapterId stringnullable

adapterName stringnullable

connectionProperties stringnullable

ackOptions

object

sendAck boolean

adapterType stringnullable

connectionProperties stringnullable

transformationSasUri stringnullable

transformationId stringnullable

transformationVersion stringnullable

ackOutboundFormat stringnullable

useZipMapping boolean

sendNegativeAck boolean

dllFileNameWithExtension stringnullable

condition

object

enabled boolean

expression stringnullable

intervalOptions

object

useInterval boolean

pollingIntervalInSeconds int32

intervalExpression stringnullable

retryOptions

object

failureRetryIntervalSeconds int32nullable

turnOffFailureRetry boolean

retryOnNonTransientFailures boolean

subIntegrations

object[]

nullable

Array [

subIntegrationId stringnullable

subintegrationName stringnullable

sender stringnullable

receiver stringnullable

loggingWebhookOverrides

object

logLevel int32

Possible values: [0, 1, 2, 3, 4]

inboundMesssageType stringnullable

outboundMessageType stringnullable

logMessageContent booleannullable

transactionTag stringnullable

customInboundDescription stringnullable

customOutboundDescription stringnullable

logMetaData booleannullable

enabled boolean

transformations

object[]

nullable

Array [

id stringnullable

transformationType stringnullable

transformationName stringnullable

properties stringnullable

]

passThrough boolean

outboundConnections

object[]

nullable

Array [

adapterType stringnullable

useProcessLock boolean

wrapperType int32

Possible values: [0, 1, 2]

mightBeWrapped boolean

adapterId stringnullable

adapterName stringnullable

connectionProperties stringnullable

ackOptions

object

sendAck boolean

adapterType stringnullable

connectionProperties stringnullable

transformationSasUri stringnullable

transformationId stringnullable

transformationVersion stringnullable

ackOutboundFormat stringnullable

useZipMapping boolean

sendNegativeAck boolean

dllFileNameWithExtension stringnullable

condition

object

enabled boolean

expression stringnullable

intervalOptions

object

useInterval boolean

pollingIntervalInSeconds int32

intervalExpression stringnullable

retryOptions

object

failureRetryIntervalSeconds int32nullable

turnOffFailureRetry boolean

retryOnNonTransientFailures boolean

]

messageOutboundFormat stringnullable

messageOutboundEncoding stringnullable

internalProperties

object

redirectInboundToRetry boolean

redirectBatchingToRetry boolean

redirectSplittingToRetry boolean

enabled boolean

preDefinedUserProperties

object

nullable

property name* string

condition

object

enabled boolean

expression stringnullable

]

companyName stringnullable
companyId stringnullable
subscriptionName stringnullable
subscriptionId stringnullable
transactionType stringnullable

loggingWebhooks

object[]

nullable

Array [

contract int32

Possible values: [0, 1]

endpointURL stringnullable

httpVerb stringnullable

webhookConnectionId stringnullable

adapterType int32

Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]

queryString stringnullable

maxRetries int32

timeout int32

authorizationHeaderKey

object

decryptedValue stringnullable

name stringnullable

version stringnullable

type int32

Possible values: [0, 1, 2, 3, 4, 5]

enabled boolean

headers

object

nullable

property name* string

logLevel int32

Possible values: [0, 1, 2, 3, 4]

inboundMesssageType stringnullable

outboundMessageType stringnullable

logMessageContent booleannullable

transactionTag stringnullable

customInboundDescription stringnullable

customOutboundDescription stringnullable

logMetaData booleannullable

useExternalContentService booleannullable

sendContentOnExternalServiceFailure booleannullable

externalContentServiceWebhook

object

endpointURL stringnullable

httpVerb stringnullable

webhookConnectionId stringnullable

authorizationHeaderType stringnullable

apimSubscriptionKey

object

decryptedValue stringnullable

name stringnullable

version stringnullable

oAuthUrl stringnullable

oAuthBody stringnullable

oAuthClientId stringnullable

oAuthClientSecret

object

decryptedValue stringnullable

name stringnullable

version stringnullable

headers

object

nullable

property name* string

body stringnullable

usePaging boolean

useDateDelta boolean

pagingType int32

Possible values: [0, 1]

nextLinkType int32

Possible values: [0, 1]

pathName stringnullable

oAuthGrantType stringnullable

oAuthUserName stringnullable

oAuthPwd

object

decryptedValue stringnullable

name stringnullable

version stringnullable

oAuthResource stringnullable

oAuthScope stringnullable

customAuthenticationProperties

object

nullable

property name* string

basicAuthenticationUserName stringnullable

basicAuthenticationPassword

object

decryptedValue stringnullable

name stringnullable

version stringnullable

newInternalMessageCorrelationId stringnullable

newInternalMessagePreserveInterchangeId boolean

useFallBackOnRequestFailed boolean

fallBackOnThreeHoundred boolean

fallBackOnFourHoundred boolean

fallBackOnFiveHoundred boolean

restConnectionPropertiesSecondary

useStaticIp boolean

terminateOnDuplicateDetection boolean

duplicateTerminationStatus stringnullable

restResponseErrorHandlingRules

object[]

nullable

Array [

statusCodes stringnullable

action int32

Possible values: [0, 1, 2]

retry boolean

customStatus stringnullable

]

customTimeout int32

useCustomTokenHeader booleannullable

customTokenHeader

object

key stringnullable

value stringnullable

]

resendWebhooks

object[]

nullable

Array [

contract int32

Possible values: [0, 1]

endpointURL stringnullable

httpVerb stringnullable

webhookConnectionId stringnullable

adapterType int32

Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]

queryString stringnullable

maxRetries int32

timeout int32

authorizationHeaderKey

object

decryptedValue stringnullable

name stringnullable

version stringnullable

type int32

Possible values: [0, 1, 2, 3, 4, 5]

enabled boolean

headers

object

nullable

property name* string

usePureMessageSending boolean

]

internalLoggingOptions

object

logLevel int32

Possible values: [0, 1, 2, 3, 4]

logMessageContent booleannullable

logMetaData booleannullable

retryOptions

object

failureCountIntervalMinutes int32nullable

reQueueMaxDelaySeconds int32nullable

reQueueMinDelaySeconds int32nullable

maxErrorsPerInterval int32nullable

numberOfRetries int32nullable

enabled boolean

turnOffErrorPersistance boolean

maxDelayActions int32nullable

inboundRetryOptions

object

failureRetryIntervalSeconds int32nullable

turnOffFailureRetry boolean

retryOnNonTransientFailures boolean
sender stringnullable
receiver stringnullable
messageInboundFormat stringnullable
messageInboundEncoding stringnullable
removeBom boolean
handleAsBinaryFile boolean

internalProperties

object

redirectInboundToRetry boolean

redirectBatchingToRetry boolean

redirectSplittingToRetry boolean
stopOnEncodingError boolean
pollingIntervalInSeconds int32
intervalExpression stringnullable
enabled boolean
environment int32

Possible values: [0, 1]

useApiKey boolean
archived boolean
moved boolean
id stringnullable
_etag stringnullable
cosmosEntityName stringnullable
createdBy stringnullable
updatedBy stringnullable
createdAtUtc date-timenullable
updatedAtUtc date-timenullable

Example (from schema)

{
  "configCorrelationId": "string",
  "description": "string",
  "inboundConnection": {
    "adapterType": "string",
    "useProcessLock": true,
    "wrapperType": 0,
    "mightBeWrapped": true,
    "adapterId": "string",
    "adapterName": "string",
    "connectionProperties": "string",
    "ackOptions": {
      "sendAck": true,
      "adapterType": "string",
      "connectionProperties": "string",
      "transformationSasUri": "string",
      "transformationId": "string",
      "transformationVersion": "string",
      "ackOutboundFormat": "string",
      "useZipMapping": true,
      "sendNegativeAck": true,
      "dllFileNameWithExtension": "string"
    },
    "condition": {
      "enabled": true,
      "expression": "string"
    },
    "intervalOptions": {
      "useInterval": true,
      "pollingIntervalInSeconds": 0,
      "intervalExpression": "string",
      "retryOptions": {
        "failureRetryIntervalSeconds": 0,
        "turnOffFailureRetry": true,
        "retryOnNonTransientFailures": true
      }
    }
  },
  "subIntegrations": [
    {
      "subIntegrationId": "string",
      "subintegrationName": "string",
      "sender": "string",
      "receiver": "string",
      "loggingWebhookOverrides": {
        "logLevel": 0,
        "inboundMesssageType": "string",
        "outboundMessageType": "string",
        "logMessageContent": true,
        "transactionTag": "string",
        "customInboundDescription": "string",
        "customOutboundDescription": "string",
        "logMetaData": true,
        "enabled": true
      },
      "transformations": [
        {
          "id": "string",
          "transformationType": "string",
          "transformationName": "string",
          "properties": "string"
        }
      ],
      "passThrough": true,
      "outboundConnections": [
        {
          "adapterType": "string",
          "useProcessLock": true,
          "wrapperType": 0,
          "mightBeWrapped": true,
          "adapterId": "string",
          "adapterName": "string",
          "connectionProperties": "string",
          "ackOptions": {
            "sendAck": true,
            "adapterType": "string",
            "connectionProperties": "string",
            "transformationSasUri": "string",
            "transformationId": "string",
            "transformationVersion": "string",
            "ackOutboundFormat": "string",
            "useZipMapping": true,
            "sendNegativeAck": true,
            "dllFileNameWithExtension": "string"
          },
          "condition": {
            "enabled": true,
            "expression": "string"
          },
          "intervalOptions": {
            "useInterval": true,
            "pollingIntervalInSeconds": 0,
            "intervalExpression": "string",
            "retryOptions": {
              "failureRetryIntervalSeconds": 0,
              "turnOffFailureRetry": true,
              "retryOnNonTransientFailures": true
            }
          }
        }
      ],
      "messageOutboundFormat": "string",
      "messageOutboundEncoding": "string",
      "internalProperties": {
        "redirectInboundToRetry": true,
        "redirectBatchingToRetry": true,
        "redirectSplittingToRetry": true
      },
      "enabled": true,
      "preDefinedUserProperties": {},
      "condition": {
        "enabled": true,
        "expression": "string"
      }
    }
  ],
  "companyName": "string",
  "companyId": "string",
  "subscriptionName": "string",
  "subscriptionId": "string",
  "transactionType": "string",
  "loggingWebhooks": [
    {
      "contract": 0,
      "endpointURL": "string",
      "httpVerb": "string",
      "webhookConnectionId": "string",
      "adapterType": 0,
      "queryString": "string",
      "maxRetries": 0,
      "timeout": 0,
      "authorizationHeaderKey": {
        "decryptedValue": "string",
        "name": "string",
        "version": "string"
      },
      "type": 0,
      "enabled": true,
      "headers": {},
      "logLevel": 0,
      "inboundMesssageType": "string",
      "outboundMessageType": "string",
      "logMessageContent": true,
      "transactionTag": "string",
      "customInboundDescription": "string",
      "customOutboundDescription": "string",
      "logMetaData": true,
      "useExternalContentService": true,
      "sendContentOnExternalServiceFailure": true,
      "externalContentServiceWebhook": {
        "endpointURL": "string",
        "httpVerb": "string",
        "webhookConnectionId": "string",
        "authorizationHeaderType": "string",
        "apimSubscriptionKey": {
          "decryptedValue": "string",
          "name": "string",
          "version": "string"
        },
        "oAuthUrl": "string",
        "oAuthBody": "string",
        "oAuthClientId": "string",
        "oAuthClientSecret": {
          "decryptedValue": "string",
          "name": "string",
          "version": "string"
        },
        "headers": {},
        "body": "string",
        "usePaging": true,
        "useDateDelta": true,
        "pagingType": 0,
        "nextLinkType": 0,
        "pathName": "string",
        "oAuthGrantType": "string",
        "oAuthUserName": "string",
        "oAuthPwd": {
          "decryptedValue": "string",
          "name": "string",
          "version": "string"
        },
        "oAuthResource": "string",
        "oAuthScope": "string",
        "customAuthenticationProperties": {},
        "basicAuthenticationUserName": "string",
        "basicAuthenticationPassword": {
          "decryptedValue": "string",
          "name": "string",
          "version": "string"
        },
        "newInternalMessageCorrelationId": "string",
        "newInternalMessagePreserveInterchangeId": true,
        "useFallBackOnRequestFailed": true,
        "fallBackOnThreeHoundred": true,
        "fallBackOnFourHoundred": true,
        "fallBackOnFiveHoundred": true,
        "useStaticIp": true,
        "terminateOnDuplicateDetection": true,
        "duplicateTerminationStatus": "string",
        "restResponseErrorHandlingRules": [
          {
            "statusCodes": "string",
            "action": 0,
            "retry": true,
            "customStatus": "string"
          }
        ],
        "customTimeout": 0,
        "useCustomTokenHeader": true,
        "customTokenHeader": {
          "key": "string",
          "value": "string"
        }
      }
    }
  ],
  "resendWebhooks": [
    {
      "contract": 0,
      "endpointURL": "string",
      "httpVerb": "string",
      "webhookConnectionId": "string",
      "adapterType": 0,
      "queryString": "string",
      "maxRetries": 0,
      "timeout": 0,
      "authorizationHeaderKey": {
        "decryptedValue": "string",
        "name": "string",
        "version": "string"
      },
      "type": 0,
      "enabled": true,
      "headers": {},
      "usePureMessageSending": true
    }
  ],
  "internalLoggingOptions": {
    "logLevel": 0,
    "logMessageContent": true,
    "logMetaData": true
  },
  "retryOptions": {
    "failureCountIntervalMinutes": 0,
    "reQueueMaxDelaySeconds": 0,
    "reQueueMinDelaySeconds": 0,
    "maxErrorsPerInterval": 0,
    "numberOfRetries": 0,
    "enabled": true,
    "turnOffErrorPersistance": true,
    "maxDelayActions": 0,
    "inboundRetryOptions": {
      "failureRetryIntervalSeconds": 0,
      "turnOffFailureRetry": true,
      "retryOnNonTransientFailures": true
    }
  },
  "sender": "string",
  "receiver": "string",
  "messageInboundFormat": "string",
  "messageInboundEncoding": "string",
  "removeBom": true,
  "handleAsBinaryFile": true,
  "internalProperties": {
    "redirectInboundToRetry": true,
    "redirectBatchingToRetry": true,
    "redirectSplittingToRetry": true
  },
  "stopOnEncodingError": true,
  "pollingIntervalInSeconds": 0,
  "intervalExpression": "string",
  "enabled": true,
  "environment": 0,
  "useApiKey": true,
  "archived": true,
  "moved": true,
  "id": "string",
  "_etag": "string",
  "cosmosEntityName": "string",
  "createdBy": "string",
  "updatedBy": "string",
  "createdAtUtc": "2024-09-27T08:40:18.485Z",
  "updatedAtUtc": "2024-09-27T08:40:18.485Z"
}

application/json; x-api-version=1.0

Schema

Schema

configCorrelationId stringnullable
description stringnullable

inboundConnection

object

adapterType stringnullable

useProcessLock boolean

wrapperType int32

Possible values: [0, 1, 2]

mightBeWrapped boolean

adapterId stringnullable

adapterName stringnullable

connectionProperties stringnullable

ackOptions

object

sendAck boolean

adapterType stringnullable

connectionProperties stringnullable

transformationSasUri stringnullable

transformationId stringnullable

transformationVersion stringnullable

ackOutboundFormat stringnullable

useZipMapping boolean

sendNegativeAck boolean

dllFileNameWithExtension stringnullable

condition

object

enabled boolean

expression stringnullable

intervalOptions

object

useInterval boolean

pollingIntervalInSeconds int32

intervalExpression stringnullable

retryOptions

object

failureRetryIntervalSeconds int32nullable

turnOffFailureRetry boolean

retryOnNonTransientFailures boolean

subIntegrations

object[]

nullable

Array [

subIntegrationId stringnullable

subintegrationName stringnullable

sender stringnullable

receiver stringnullable

loggingWebhookOverrides

object

logLevel int32

Possible values: [0, 1, 2, 3, 4]

inboundMesssageType stringnullable

outboundMessageType stringnullable

logMessageContent booleannullable

transactionTag stringnullable

customInboundDescription stringnullable

customOutboundDescription stringnullable

logMetaData booleannullable

enabled boolean

transformations

object[]

nullable

Array [

id stringnullable

transformationType stringnullable

transformationName stringnullable

properties stringnullable

]

passThrough boolean

outboundConnections

object[]

nullable

Array [

adapterType stringnullable

useProcessLock boolean

wrapperType int32

Possible values: [0, 1, 2]

mightBeWrapped boolean

adapterId stringnullable

adapterName stringnullable

connectionProperties stringnullable

ackOptions

object

sendAck boolean

adapterType stringnullable

connectionProperties stringnullable

transformationSasUri stringnullable

transformationId stringnullable

transformationVersion stringnullable

ackOutboundFormat stringnullable

useZipMapping boolean

sendNegativeAck boolean

dllFileNameWithExtension stringnullable

condition

object

enabled boolean

expression stringnullable

intervalOptions

object

useInterval boolean

pollingIntervalInSeconds int32

intervalExpression stringnullable

retryOptions

object

failureRetryIntervalSeconds int32nullable

turnOffFailureRetry boolean

retryOnNonTransientFailures boolean

]

messageOutboundFormat stringnullable

messageOutboundEncoding stringnullable

internalProperties

object

redirectInboundToRetry boolean

redirectBatchingToRetry boolean

redirectSplittingToRetry boolean

enabled boolean

preDefinedUserProperties

object

nullable

property name* string

condition

object

enabled boolean

expression stringnullable

]

companyName stringnullable
companyId stringnullable
subscriptionName stringnullable
subscriptionId stringnullable
transactionType stringnullable

loggingWebhooks

object[]

nullable

Array [

contract int32

Possible values: [0, 1]

endpointURL stringnullable

httpVerb stringnullable

webhookConnectionId stringnullable

adapterType int32

Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]

queryString stringnullable

maxRetries int32

timeout int32

authorizationHeaderKey

object

decryptedValue stringnullable

name stringnullable

version stringnullable

type int32

Possible values: [0, 1, 2, 3, 4, 5]

enabled boolean

headers

object

nullable

property name* string

logLevel int32

Possible values: [0, 1, 2, 3, 4]

inboundMesssageType stringnullable

outboundMessageType stringnullable

logMessageContent booleannullable

transactionTag stringnullable

customInboundDescription stringnullable

customOutboundDescription stringnullable

logMetaData booleannullable

useExternalContentService booleannullable

sendContentOnExternalServiceFailure booleannullable

externalContentServiceWebhook

object

endpointURL stringnullable

httpVerb stringnullable

webhookConnectionId stringnullable

authorizationHeaderType stringnullable

apimSubscriptionKey

object

decryptedValue stringnullable

name stringnullable

version stringnullable

oAuthUrl stringnullable

oAuthBody stringnullable

oAuthClientId stringnullable

oAuthClientSecret

object

decryptedValue stringnullable

name stringnullable

version stringnullable

headers

object

nullable

property name* string

body stringnullable

usePaging boolean

useDateDelta boolean

pagingType int32

Possible values: [0, 1]

nextLinkType int32

Possible values: [0, 1]

pathName stringnullable

oAuthGrantType stringnullable

oAuthUserName stringnullable

oAuthPwd

object

decryptedValue stringnullable

name stringnullable

version stringnullable

oAuthResource stringnullable

oAuthScope stringnullable

customAuthenticationProperties

object

nullable

property name* string

basicAuthenticationUserName stringnullable

basicAuthenticationPassword

object

decryptedValue stringnullable

name stringnullable

version stringnullable

newInternalMessageCorrelationId stringnullable

newInternalMessagePreserveInterchangeId boolean

useFallBackOnRequestFailed boolean

fallBackOnThreeHoundred boolean

fallBackOnFourHoundred boolean

fallBackOnFiveHoundred boolean

restConnectionPropertiesSecondary

useStaticIp boolean

terminateOnDuplicateDetection boolean

duplicateTerminationStatus stringnullable

restResponseErrorHandlingRules

object[]

nullable

Array [

statusCodes stringnullable

action int32

Possible values: [0, 1, 2]

retry boolean

customStatus stringnullable

]

customTimeout int32

useCustomTokenHeader booleannullable

customTokenHeader

object

key stringnullable

value stringnullable

]

resendWebhooks

object[]

nullable

Array [

contract int32

Possible values: [0, 1]

endpointURL stringnullable

httpVerb stringnullable

webhookConnectionId stringnullable

adapterType int32

Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]

queryString stringnullable

maxRetries int32

timeout int32

authorizationHeaderKey

object

decryptedValue stringnullable

name stringnullable

version stringnullable

type int32

Possible values: [0, 1, 2, 3, 4, 5]

enabled boolean

headers

object

nullable

property name* string

usePureMessageSending boolean

]

internalLoggingOptions

object

logLevel int32

Possible values: [0, 1, 2, 3, 4]

logMessageContent booleannullable

logMetaData booleannullable

retryOptions

object

failureCountIntervalMinutes int32nullable

reQueueMaxDelaySeconds int32nullable

reQueueMinDelaySeconds int32nullable

maxErrorsPerInterval int32nullable

numberOfRetries int32nullable

enabled boolean

turnOffErrorPersistance boolean

maxDelayActions int32nullable

inboundRetryOptions

object

failureRetryIntervalSeconds int32nullable

turnOffFailureRetry boolean

retryOnNonTransientFailures boolean
sender stringnullable
receiver stringnullable
messageInboundFormat stringnullable
messageInboundEncoding stringnullable
removeBom boolean
handleAsBinaryFile boolean

internalProperties

object

redirectInboundToRetry boolean

redirectBatchingToRetry boolean

redirectSplittingToRetry boolean
stopOnEncodingError boolean
pollingIntervalInSeconds int32
intervalExpression stringnullable
enabled boolean
environment int32

Possible values: [0, 1]

useApiKey boolean
archived boolean
moved boolean
id stringnullable
_etag stringnullable
cosmosEntityName stringnullable
createdBy stringnullable
updatedBy stringnullable
createdAtUtc date-timenullable
updatedAtUtc date-timenullable

Example (from schema)

{
  "configCorrelationId": "string",
  "description": "string",
  "inboundConnection": {
    "adapterType": "string",
    "useProcessLock": true,
    "wrapperType": 0,
    "mightBeWrapped": true,
    "adapterId": "string",
    "adapterName": "string",
    "connectionProperties": "string",
    "ackOptions": {
      "sendAck": true,
      "adapterType": "string",
      "connectionProperties": "string",
      "transformationSasUri": "string",
      "transformationId": "string",
      "transformationVersion": "string",
      "ackOutboundFormat": "string",
      "useZipMapping": true,
      "sendNegativeAck": true,
      "dllFileNameWithExtension": "string"
    },
    "condition": {
      "enabled": true,
      "expression": "string"
    },
    "intervalOptions": {
      "useInterval": true,
      "pollingIntervalInSeconds": 0,
      "intervalExpression": "string",
      "retryOptions": {
        "failureRetryIntervalSeconds": 0,
        "turnOffFailureRetry": true,
        "retryOnNonTransientFailures": true
      }
    }
  },
  "subIntegrations": [
    {
      "subIntegrationId": "string",
      "subintegrationName": "string",
      "sender": "string",
      "receiver": "string",
      "loggingWebhookOverrides": {
        "logLevel": 0,
        "inboundMesssageType": "string",
        "outboundMessageType": "string",
        "logMessageContent": true,
        "transactionTag": "string",
        "customInboundDescription": "string",
        "customOutboundDescription": "string",
        "logMetaData": true,
        "enabled": true
      },
      "transformations": [
        {
          "id": "string",
          "transformationType": "string",
          "transformationName": "string",
          "properties": "string"
        }
      ],
      "passThrough": true,
      "outboundConnections": [
        {
          "adapterType": "string",
          "useProcessLock": true,
          "wrapperType": 0,
          "mightBeWrapped": true,
          "adapterId": "string",
          "adapterName": "string",
          "connectionProperties": "string",
          "ackOptions": {
            "sendAck": true,
            "adapterType": "string",
            "connectionProperties": "string",
            "transformationSasUri": "string",
            "transformationId": "string",
            "transformationVersion": "string",
            "ackOutboundFormat": "string",
            "useZipMapping": true,
            "sendNegativeAck": true,
            "dllFileNameWithExtension": "string"
          },
          "condition": {
            "enabled": true,
            "expression": "string"
          },
          "intervalOptions": {
            "useInterval": true,
            "pollingIntervalInSeconds": 0,
            "intervalExpression": "string",
            "retryOptions": {
              "failureRetryIntervalSeconds": 0,
              "turnOffFailureRetry": true,
              "retryOnNonTransientFailures": true
            }
          }
        }
      ],
      "messageOutboundFormat": "string",
      "messageOutboundEncoding": "string",
      "internalProperties": {
        "redirectInboundToRetry": true,
        "redirectBatchingToRetry": true,
        "redirectSplittingToRetry": true
      },
      "enabled": true,
      "preDefinedUserProperties": {},
      "condition": {
        "enabled": true,
        "expression": "string"
      }
    }
  ],
  "companyName": "string",
  "companyId": "string",
  "subscriptionName": "string",
  "subscriptionId": "string",
  "transactionType": "string",
  "loggingWebhooks": [
    {
      "contract": 0,
      "endpointURL": "string",
      "httpVerb": "string",
      "webhookConnectionId": "string",
      "adapterType": 0,
      "queryString": "string",
      "maxRetries": 0,
      "timeout": 0,
      "authorizationHeaderKey": {
        "decryptedValue": "string",
        "name": "string",
        "version": "string"
      },
      "type": 0,
      "enabled": true,
      "headers": {},
      "logLevel": 0,
      "inboundMesssageType": "string",
      "outboundMessageType": "string",
      "logMessageContent": true,
      "transactionTag": "string",
      "customInboundDescription": "string",
      "customOutboundDescription": "string",
      "logMetaData": true,
      "useExternalContentService": true,
      "sendContentOnExternalServiceFailure": true,
      "externalContentServiceWebhook": {
        "endpointURL": "string",
        "httpVerb": "string",
        "webhookConnectionId": "string",
        "authorizationHeaderType": "string",
        "apimSubscriptionKey": {
          "decryptedValue": "string",
          "name": "string",
          "version": "string"
        },
        "oAuthUrl": "string",
        "oAuthBody": "string",
        "oAuthClientId": "string",
        "oAuthClientSecret": {
          "decryptedValue": "string",
          "name": "string",
          "version": "string"
        },
        "headers": {},
        "body": "string",
        "usePaging": true,
        "useDateDelta": true,
        "pagingType": 0,
        "nextLinkType": 0,
        "pathName": "string",
        "oAuthGrantType": "string",
        "oAuthUserName": "string",
        "oAuthPwd": {
          "decryptedValue": "string",
          "name": "string",
          "version": "string"
        },
        "oAuthResource": "string",
        "oAuthScope": "string",
        "customAuthenticationProperties": {},
        "basicAuthenticationUserName": "string",
        "basicAuthenticationPassword": {
          "decryptedValue": "string",
          "name": "string",
          "version": "string"
        },
        "newInternalMessageCorrelationId": "string",
        "newInternalMessagePreserveInterchangeId": true,
        "useFallBackOnRequestFailed": true,
        "fallBackOnThreeHoundred": true,
        "fallBackOnFourHoundred": true,
        "fallBackOnFiveHoundred": true,
        "useStaticIp": true,
        "terminateOnDuplicateDetection": true,
        "duplicateTerminationStatus": "string",
        "restResponseErrorHandlingRules": [
          {
            "statusCodes": "string",
            "action": 0,
            "retry": true,
            "customStatus": "string"
          }
        ],
        "customTimeout": 0,
        "useCustomTokenHeader": true,
        "customTokenHeader": {
          "key": "string",
          "value": "string"
        }
      }
    }
  ],
  "resendWebhooks": [
    {
      "contract": 0,
      "endpointURL": "string",
      "httpVerb": "string",
      "webhookConnectionId": "string",
      "adapterType": 0,
      "queryString": "string",
      "maxRetries": 0,
      "timeout": 0,
      "authorizationHeaderKey": {
        "decryptedValue": "string",
        "name": "string",
        "version": "string"
      },
      "type": 0,
      "enabled": true,
      "headers": {},
      "usePureMessageSending": true
    }
  ],
  "internalLoggingOptions": {
    "logLevel": 0,
    "logMessageContent": true,
    "logMetaData": true
  },
  "retryOptions": {
    "failureCountIntervalMinutes": 0,
    "reQueueMaxDelaySeconds": 0,
    "reQueueMinDelaySeconds": 0,
    "maxErrorsPerInterval": 0,
    "numberOfRetries": 0,
    "enabled": true,
    "turnOffErrorPersistance": true,
    "maxDelayActions": 0,
    "inboundRetryOptions": {
      "failureRetryIntervalSeconds": 0,
      "turnOffFailureRetry": true,
      "retryOnNonTransientFailures": true
    }
  },
  "sender": "string",
  "receiver": "string",
  "messageInboundFormat": "string",
  "messageInboundEncoding": "string",
  "removeBom": true,
  "handleAsBinaryFile": true,
  "internalProperties": {
    "redirectInboundToRetry": true,
    "redirectBatchingToRetry": true,
    "redirectSplittingToRetry": true
  },
  "stopOnEncodingError": true,
  "pollingIntervalInSeconds": 0,
  "intervalExpression": "string",
  "enabled": true,
  "environment": 0,
  "useApiKey": true,
  "archived": true,
  "moved": true,
  "id": "string",
  "_etag": "string",
  "cosmosEntityName": "string",
  "createdBy": "string",
  "updatedBy": "string",
  "createdAtUtc": "2024-09-27T08:40:18.488Z",
  "updatedAtUtc": "2024-09-27T08:40:18.488Z"
}

text/json; x-api-version=1.0

Schema

Schema

configCorrelationId stringnullable
description stringnullable

inboundConnection

object

adapterType stringnullable

useProcessLock boolean

wrapperType int32

Possible values: [0, 1, 2]

mightBeWrapped boolean

adapterId stringnullable

adapterName stringnullable

connectionProperties stringnullable

ackOptions

object

sendAck boolean

adapterType stringnullable

connectionProperties stringnullable

transformationSasUri stringnullable

transformationId stringnullable

transformationVersion stringnullable

ackOutboundFormat stringnullable

useZipMapping boolean

sendNegativeAck boolean

dllFileNameWithExtension stringnullable

condition

object

enabled boolean

expression stringnullable

intervalOptions

object

useInterval boolean

pollingIntervalInSeconds int32

intervalExpression stringnullable

retryOptions

object

failureRetryIntervalSeconds int32nullable

turnOffFailureRetry boolean

retryOnNonTransientFailures boolean

subIntegrations

object[]

nullable

Array [

subIntegrationId stringnullable

subintegrationName stringnullable

sender stringnullable

receiver stringnullable

loggingWebhookOverrides

object

logLevel int32

Possible values: [0, 1, 2, 3, 4]

inboundMesssageType stringnullable

outboundMessageType stringnullable

logMessageContent booleannullable

transactionTag stringnullable

customInboundDescription stringnullable

customOutboundDescription stringnullable

logMetaData booleannullable

enabled boolean

transformations

object[]

nullable

Array [

id stringnullable

transformationType stringnullable

transformationName stringnullable

properties stringnullable

]

passThrough boolean

outboundConnections

object[]

nullable

Array [

adapterType stringnullable

useProcessLock boolean

wrapperType int32

Possible values: [0, 1, 2]

mightBeWrapped boolean

adapterId stringnullable

adapterName stringnullable

connectionProperties stringnullable

ackOptions

object

sendAck boolean

adapterType stringnullable

connectionProperties stringnullable

transformationSasUri stringnullable

transformationId stringnullable

transformationVersion stringnullable

ackOutboundFormat stringnullable

useZipMapping boolean

sendNegativeAck boolean

dllFileNameWithExtension stringnullable

condition

object

enabled boolean

expression stringnullable

intervalOptions

object

useInterval boolean

pollingIntervalInSeconds int32

intervalExpression stringnullable

retryOptions

object

failureRetryIntervalSeconds int32nullable

turnOffFailureRetry boolean

retryOnNonTransientFailures boolean

]

messageOutboundFormat stringnullable

messageOutboundEncoding stringnullable

internalProperties

object

redirectInboundToRetry boolean

redirectBatchingToRetry boolean

redirectSplittingToRetry boolean

enabled boolean

preDefinedUserProperties

object

nullable

property name* string

condition

object

enabled boolean

expression stringnullable

]

companyName stringnullable
companyId stringnullable
subscriptionName stringnullable
subscriptionId stringnullable
transactionType stringnullable

loggingWebhooks

object[]

nullable

Array [

contract int32

Possible values: [0, 1]

endpointURL stringnullable

httpVerb stringnullable

webhookConnectionId stringnullable

adapterType int32

Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]

queryString stringnullable

maxRetries int32

timeout int32

authorizationHeaderKey

object

decryptedValue stringnullable

name stringnullable

version stringnullable

type int32

Possible values: [0, 1, 2, 3, 4, 5]

enabled boolean

headers

object

nullable

property name* string

logLevel int32

Possible values: [0, 1, 2, 3, 4]

inboundMesssageType stringnullable

outboundMessageType stringnullable

logMessageContent booleannullable

transactionTag stringnullable

customInboundDescription stringnullable

customOutboundDescription stringnullable

logMetaData booleannullable

useExternalContentService booleannullable

sendContentOnExternalServiceFailure booleannullable

externalContentServiceWebhook

object

endpointURL stringnullable

httpVerb stringnullable

webhookConnectionId stringnullable

authorizationHeaderType stringnullable

apimSubscriptionKey

object

decryptedValue stringnullable

name stringnullable

version stringnullable

oAuthUrl stringnullable

oAuthBody stringnullable

oAuthClientId stringnullable

oAuthClientSecret

object

decryptedValue stringnullable

name stringnullable

version stringnullable

headers

object

nullable

property name* string

body stringnullable

usePaging boolean

useDateDelta boolean

pagingType int32

Possible values: [0, 1]

nextLinkType int32

Possible values: [0, 1]

pathName stringnullable

oAuthGrantType stringnullable

oAuthUserName stringnullable

oAuthPwd

object

decryptedValue stringnullable

name stringnullable

version stringnullable

oAuthResource stringnullable

oAuthScope stringnullable

customAuthenticationProperties

object

nullable

property name* string

basicAuthenticationUserName stringnullable

basicAuthenticationPassword

object

decryptedValue stringnullable

name stringnullable

version stringnullable

newInternalMessageCorrelationId stringnullable

newInternalMessagePreserveInterchangeId boolean

useFallBackOnRequestFailed boolean

fallBackOnThreeHoundred boolean

fallBackOnFourHoundred boolean

fallBackOnFiveHoundred boolean

restConnectionPropertiesSecondary

useStaticIp boolean

terminateOnDuplicateDetection boolean

duplicateTerminationStatus stringnullable

restResponseErrorHandlingRules

object[]

nullable

Array [

statusCodes stringnullable

action int32

Possible values: [0, 1, 2]

retry boolean

customStatus stringnullable

]

customTimeout int32

useCustomTokenHeader booleannullable

customTokenHeader

object

key stringnullable

value stringnullable

]

resendWebhooks

object[]

nullable

Array [

contract int32

Possible values: [0, 1]

endpointURL stringnullable

httpVerb stringnullable

webhookConnectionId stringnullable

adapterType int32

Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]

queryString stringnullable

maxRetries int32

timeout int32

authorizationHeaderKey

object

decryptedValue stringnullable

name stringnullable

version stringnullable

type int32

Possible values: [0, 1, 2, 3, 4, 5]

enabled boolean

headers

object

nullable

property name* string

usePureMessageSending boolean

]

internalLoggingOptions

object

logLevel int32

Possible values: [0, 1, 2, 3, 4]

logMessageContent booleannullable

logMetaData booleannullable

retryOptions

object

failureCountIntervalMinutes int32nullable

reQueueMaxDelaySeconds int32nullable

reQueueMinDelaySeconds int32nullable

maxErrorsPerInterval int32nullable

numberOfRetries int32nullable

enabled boolean

turnOffErrorPersistance boolean

maxDelayActions int32nullable

inboundRetryOptions

object

failureRetryIntervalSeconds int32nullable

turnOffFailureRetry boolean

retryOnNonTransientFailures boolean
sender stringnullable
receiver stringnullable
messageInboundFormat stringnullable
messageInboundEncoding stringnullable
removeBom boolean
handleAsBinaryFile boolean

internalProperties

object

redirectInboundToRetry boolean

redirectBatchingToRetry boolean

redirectSplittingToRetry boolean
stopOnEncodingError boolean
pollingIntervalInSeconds int32
intervalExpression stringnullable
enabled boolean
environment int32

Possible values: [0, 1]

useApiKey boolean
archived boolean
moved boolean
id stringnullable
_etag stringnullable
cosmosEntityName stringnullable
createdBy stringnullable
updatedBy stringnullable
createdAtUtc date-timenullable
updatedAtUtc date-timenullable

Example (from schema)

{
  "configCorrelationId": "string",
  "description": "string",
  "inboundConnection": {
    "adapterType": "string",
    "useProcessLock": true,
    "wrapperType": 0,
    "mightBeWrapped": true,
    "adapterId": "string",
    "adapterName": "string",
    "connectionProperties": "string",
    "ackOptions": {
      "sendAck": true,
      "adapterType": "string",
      "connectionProperties": "string",
      "transformationSasUri": "string",
      "transformationId": "string",
      "transformationVersion": "string",
      "ackOutboundFormat": "string",
      "useZipMapping": true,
      "sendNegativeAck": true,
      "dllFileNameWithExtension": "string"
    },
    "condition": {
      "enabled": true,
      "expression": "string"
    },
    "intervalOptions": {
      "useInterval": true,
      "pollingIntervalInSeconds": 0,
      "intervalExpression": "string",
      "retryOptions": {
        "failureRetryIntervalSeconds": 0,
        "turnOffFailureRetry": true,
        "retryOnNonTransientFailures": true
      }
    }
  },
  "subIntegrations": [
    {
      "subIntegrationId": "string",
      "subintegrationName": "string",
      "sender": "string",
      "receiver": "string",
      "loggingWebhookOverrides": {
        "logLevel": 0,
        "inboundMesssageType": "string",
        "outboundMessageType": "string",
        "logMessageContent": true,
        "transactionTag": "string",
        "customInboundDescription": "string",
        "customOutboundDescription": "string",
        "logMetaData": true,
        "enabled": true
      },
      "transformations": [
        {
          "id": "string",
          "transformationType": "string",
          "transformationName": "string",
          "properties": "string"
        }
      ],
      "passThrough": true,
      "outboundConnections": [
        {
          "adapterType": "string",
          "useProcessLock": true,
          "wrapperType": 0,
          "mightBeWrapped": true,
          "adapterId": "string",
          "adapterName": "string",
          "connectionProperties": "string",
          "ackOptions": {
            "sendAck": true,
            "adapterType": "string",
            "connectionProperties": "string",
            "transformationSasUri": "string",
            "transformationId": "string",
            "transformationVersion": "string",
            "ackOutboundFormat": "string",
            "useZipMapping": true,
            "sendNegativeAck": true,
            "dllFileNameWithExtension": "string"
          },
          "condition": {
            "enabled": true,
            "expression": "string"
          },
          "intervalOptions": {
            "useInterval": true,
            "pollingIntervalInSeconds": 0,
            "intervalExpression": "string",
            "retryOptions": {
              "failureRetryIntervalSeconds": 0,
              "turnOffFailureRetry": true,
              "retryOnNonTransientFailures": true
            }
          }
        }
      ],
      "messageOutboundFormat": "string",
      "messageOutboundEncoding": "string",
      "internalProperties": {
        "redirectInboundToRetry": true,
        "redirectBatchingToRetry": true,
        "redirectSplittingToRetry": true
      },
      "enabled": true,
      "preDefinedUserProperties": {},
      "condition": {
        "enabled": true,
        "expression": "string"
      }
    }
  ],
  "companyName": "string",
  "companyId": "string",
  "subscriptionName": "string",
  "subscriptionId": "string",
  "transactionType": "string",
  "loggingWebhooks": [
    {
      "contract": 0,
      "endpointURL": "string",
      "httpVerb": "string",
      "webhookConnectionId": "string",
      "adapterType": 0,
      "queryString": "string",
      "maxRetries": 0,
      "timeout": 0,
      "authorizationHeaderKey": {
        "decryptedValue": "string",
        "name": "string",
        "version": "string"
      },
      "type": 0,
      "enabled": true,
      "headers": {},
      "logLevel": 0,
      "inboundMesssageType": "string",
      "outboundMessageType": "string",
      "logMessageContent": true,
      "transactionTag": "string",
      "customInboundDescription": "string",
      "customOutboundDescription": "string",
      "logMetaData": true,
      "useExternalContentService": true,
      "sendContentOnExternalServiceFailure": true,
      "externalContentServiceWebhook": {
        "endpointURL": "string",
        "httpVerb": "string",
        "webhookConnectionId": "string",
        "authorizationHeaderType": "string",
        "apimSubscriptionKey": {
          "decryptedValue": "string",
          "name": "string",
          "version": "string"
        },
        "oAuthUrl": "string",
        "oAuthBody": "string",
        "oAuthClientId": "string",
        "oAuthClientSecret": {
          "decryptedValue": "string",
          "name": "string",
          "version": "string"
        },
        "headers": {},
        "body": "string",
        "usePaging": true,
        "useDateDelta": true,
        "pagingType": 0,
        "nextLinkType": 0,
        "pathName": "string",
        "oAuthGrantType": "string",
        "oAuthUserName": "string",
        "oAuthPwd": {
          "decryptedValue": "string",
          "name": "string",
          "version": "string"
        },
        "oAuthResource": "string",
        "oAuthScope": "string",
        "customAuthenticationProperties": {},
        "basicAuthenticationUserName": "string",
        "basicAuthenticationPassword": {
          "decryptedValue": "string",
          "name": "string",
          "version": "string"
        },
        "newInternalMessageCorrelationId": "string",
        "newInternalMessagePreserveInterchangeId": true,
        "useFallBackOnRequestFailed": true,
        "fallBackOnThreeHoundred": true,
        "fallBackOnFourHoundred": true,
        "fallBackOnFiveHoundred": true,
        "useStaticIp": true,
        "terminateOnDuplicateDetection": true,
        "duplicateTerminationStatus": "string",
        "restResponseErrorHandlingRules": [
          {
            "statusCodes": "string",
            "action": 0,
            "retry": true,
            "customStatus": "string"
          }
        ],
        "customTimeout": 0,
        "useCustomTokenHeader": true,
        "customTokenHeader": {
          "key": "string",
          "value": "string"
        }
      }
    }
  ],
  "resendWebhooks": [
    {
      "contract": 0,
      "endpointURL": "string",
      "httpVerb": "string",
      "webhookConnectionId": "string",
      "adapterType": 0,
      "queryString": "string",
      "maxRetries": 0,
      "timeout": 0,
      "authorizationHeaderKey": {
        "decryptedValue": "string",
        "name": "string",
        "version": "string"
      },
      "type": 0,
      "enabled": true,
      "headers": {},
      "usePureMessageSending": true
    }
  ],
  "internalLoggingOptions": {
    "logLevel": 0,
    "logMessageContent": true,
    "logMetaData": true
  },
  "retryOptions": {
    "failureCountIntervalMinutes": 0,
    "reQueueMaxDelaySeconds": 0,
    "reQueueMinDelaySeconds": 0,
    "maxErrorsPerInterval": 0,
    "numberOfRetries": 0,
    "enabled": true,
    "turnOffErrorPersistance": true,
    "maxDelayActions": 0,
    "inboundRetryOptions": {
      "failureRetryIntervalSeconds": 0,
      "turnOffFailureRetry": true,
      "retryOnNonTransientFailures": true
    }
  },
  "sender": "string",
  "receiver": "string",
  "messageInboundFormat": "string",
  "messageInboundEncoding": "string",
  "removeBom": true,
  "handleAsBinaryFile": true,
  "internalProperties": {
    "redirectInboundToRetry": true,
    "redirectBatchingToRetry": true,
    "redirectSplittingToRetry": true
  },
  "stopOnEncodingError": true,
  "pollingIntervalInSeconds": 0,
  "intervalExpression": "string",
  "enabled": true,
  "environment": 0,
  "useApiKey": true,
  "archived": true,
  "moved": true,
  "id": "string",
  "_etag": "string",
  "cosmosEntityName": "string",
  "createdBy": "string",
  "updatedBy": "string",
  "createdAtUtc": "2024-09-27T08:40:18.493Z",
  "updatedAtUtc": "2024-09-27T08:40:18.493Z"
}

application/xml; x-api-version=1.0

Schema

Schema

configCorrelationId stringnullable
description stringnullable

inboundConnection

object

adapterType stringnullable

useProcessLock boolean

wrapperType int32

Possible values: [0, 1, 2]

mightBeWrapped boolean

adapterId stringnullable

adapterName stringnullable

connectionProperties stringnullable

ackOptions

object

sendAck boolean

adapterType stringnullable

connectionProperties stringnullable

transformationSasUri stringnullable

transformationId stringnullable

transformationVersion stringnullable

ackOutboundFormat stringnullable

useZipMapping boolean

sendNegativeAck boolean

dllFileNameWithExtension stringnullable

condition

object

enabled boolean

expression stringnullable

intervalOptions

object

useInterval boolean

pollingIntervalInSeconds int32

intervalExpression stringnullable

retryOptions

object

failureRetryIntervalSeconds int32nullable

turnOffFailureRetry boolean

retryOnNonTransientFailures boolean

subIntegrations

object[]

nullable

Array [

subIntegrationId stringnullable

subintegrationName stringnullable

sender stringnullable

receiver stringnullable

loggingWebhookOverrides

object

logLevel int32

Possible values: [0, 1, 2, 3, 4]

inboundMesssageType stringnullable

outboundMessageType stringnullable

logMessageContent booleannullable

transactionTag stringnullable

customInboundDescription stringnullable

customOutboundDescription stringnullable

logMetaData booleannullable

enabled boolean

transformations

object[]

nullable

Array [

id stringnullable

transformationType stringnullable

transformationName stringnullable

properties stringnullable

]

passThrough boolean

outboundConnections

object[]

nullable

Array [

adapterType stringnullable

useProcessLock boolean

wrapperType int32

Possible values: [0, 1, 2]

mightBeWrapped boolean

adapterId stringnullable

adapterName stringnullable

connectionProperties stringnullable

ackOptions

object

sendAck boolean

adapterType stringnullable

connectionProperties stringnullable

transformationSasUri stringnullable

transformationId stringnullable

transformationVersion stringnullable

ackOutboundFormat stringnullable

useZipMapping boolean

sendNegativeAck boolean

dllFileNameWithExtension stringnullable

condition

object

enabled boolean

expression stringnullable

intervalOptions

object

useInterval boolean

pollingIntervalInSeconds int32

intervalExpression stringnullable

retryOptions

object

failureRetryIntervalSeconds int32nullable

turnOffFailureRetry boolean

retryOnNonTransientFailures boolean

]

messageOutboundFormat stringnullable

messageOutboundEncoding stringnullable

internalProperties

object

redirectInboundToRetry boolean

redirectBatchingToRetry boolean

redirectSplittingToRetry boolean

enabled boolean

preDefinedUserProperties

object

nullable

property name* string

condition

object

enabled boolean

expression stringnullable

]

companyName stringnullable
companyId stringnullable
subscriptionName stringnullable
subscriptionId stringnullable
transactionType stringnullable

loggingWebhooks

object[]

nullable

Array [

contract int32

Possible values: [0, 1]

endpointURL stringnullable

httpVerb stringnullable

webhookConnectionId stringnullable

adapterType int32

Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]

queryString stringnullable

maxRetries int32

timeout int32

authorizationHeaderKey

object

decryptedValue stringnullable

name stringnullable

version stringnullable

type int32

Possible values: [0, 1, 2, 3, 4, 5]

enabled boolean

headers

object

nullable

property name* string

logLevel int32

Possible values: [0, 1, 2, 3, 4]

inboundMesssageType stringnullable

outboundMessageType stringnullable

logMessageContent booleannullable

transactionTag stringnullable

customInboundDescription stringnullable

customOutboundDescription stringnullable

logMetaData booleannullable

useExternalContentService booleannullable

sendContentOnExternalServiceFailure booleannullable

externalContentServiceWebhook

object

endpointURL stringnullable

httpVerb stringnullable

webhookConnectionId stringnullable

authorizationHeaderType stringnullable

apimSubscriptionKey

object

decryptedValue stringnullable

name stringnullable

version stringnullable

oAuthUrl stringnullable

oAuthBody stringnullable

oAuthClientId stringnullable

oAuthClientSecret

object

decryptedValue stringnullable

name stringnullable

version stringnullable

headers

object

nullable

property name* string

body stringnullable

usePaging boolean

useDateDelta boolean

pagingType int32

Possible values: [0, 1]

nextLinkType int32

Possible values: [0, 1]

pathName stringnullable

oAuthGrantType stringnullable

oAuthUserName stringnullable

oAuthPwd

object

decryptedValue stringnullable

name stringnullable

version stringnullable

oAuthResource stringnullable

oAuthScope stringnullable

customAuthenticationProperties

object

nullable

property name* string

basicAuthenticationUserName stringnullable

basicAuthenticationPassword

object

decryptedValue stringnullable

name stringnullable

version stringnullable

newInternalMessageCorrelationId stringnullable

newInternalMessagePreserveInterchangeId boolean

useFallBackOnRequestFailed boolean

fallBackOnThreeHoundred boolean

fallBackOnFourHoundred boolean

fallBackOnFiveHoundred boolean

restConnectionPropertiesSecondary

useStaticIp boolean

terminateOnDuplicateDetection boolean

duplicateTerminationStatus stringnullable

restResponseErrorHandlingRules

object[]

nullable

Array [

statusCodes stringnullable

action int32

Possible values: [0, 1, 2]

retry boolean

customStatus stringnullable

]

customTimeout int32

useCustomTokenHeader booleannullable

customTokenHeader

object

key stringnullable

value stringnullable

]

resendWebhooks

object[]

nullable

Array [

contract int32

Possible values: [0, 1]

endpointURL stringnullable

httpVerb stringnullable

webhookConnectionId stringnullable

adapterType int32

Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]

queryString stringnullable

maxRetries int32

timeout int32

authorizationHeaderKey

object

decryptedValue stringnullable

name stringnullable

version stringnullable

type int32

Possible values: [0, 1, 2, 3, 4, 5]

enabled boolean

headers

object

nullable

property name* string

usePureMessageSending boolean

]

internalLoggingOptions

object

logLevel int32

Possible values: [0, 1, 2, 3, 4]

logMessageContent booleannullable

logMetaData booleannullable

retryOptions

object

failureCountIntervalMinutes int32nullable

reQueueMaxDelaySeconds int32nullable

reQueueMinDelaySeconds int32nullable

maxErrorsPerInterval int32nullable

numberOfRetries int32nullable

enabled boolean

turnOffErrorPersistance boolean

maxDelayActions int32nullable

inboundRetryOptions

object

failureRetryIntervalSeconds int32nullable

turnOffFailureRetry boolean

retryOnNonTransientFailures boolean
sender stringnullable
receiver stringnullable
messageInboundFormat stringnullable
messageInboundEncoding stringnullable
removeBom boolean
handleAsBinaryFile boolean

internalProperties

object

redirectInboundToRetry boolean

redirectBatchingToRetry boolean

redirectSplittingToRetry boolean
stopOnEncodingError boolean
pollingIntervalInSeconds int32
intervalExpression stringnullable
enabled boolean
environment int32

Possible values: [0, 1]

useApiKey boolean
archived boolean
moved boolean
id stringnullable
_etag stringnullable
cosmosEntityName stringnullable
createdBy stringnullable
updatedBy stringnullable
createdAtUtc date-timenullable
updatedAtUtc date-timenullable

Example (from schema)

{
  "configCorrelationId": "string",
  "description": "string",
  "inboundConnection": {
    "adapterType": "string",
    "useProcessLock": true,
    "wrapperType": 0,
    "mightBeWrapped": true,
    "adapterId": "string",
    "adapterName": "string",
    "connectionProperties": "string",
    "ackOptions": {
      "sendAck": true,
      "adapterType": "string",
      "connectionProperties": "string",
      "transformationSasUri": "string",
      "transformationId": "string",
      "transformationVersion": "string",
      "ackOutboundFormat": "string",
      "useZipMapping": true,
      "sendNegativeAck": true,
      "dllFileNameWithExtension": "string"
    },
    "condition": {
      "enabled": true,
      "expression": "string"
    },
    "intervalOptions": {
      "useInterval": true,
      "pollingIntervalInSeconds": 0,
      "intervalExpression": "string",
      "retryOptions": {
        "failureRetryIntervalSeconds": 0,
        "turnOffFailureRetry": true,
        "retryOnNonTransientFailures": true
      }
    }
  },
  "subIntegrations": [
    {
      "subIntegrationId": "string",
      "subintegrationName": "string",
      "sender": "string",
      "receiver": "string",
      "loggingWebhookOverrides": {
        "logLevel": 0,
        "inboundMesssageType": "string",
        "outboundMessageType": "string",
        "logMessageContent": true,
        "transactionTag": "string",
        "customInboundDescription": "string",
        "customOutboundDescription": "string",
        "logMetaData": true,
        "enabled": true
      },
      "transformations": [
        {
          "id": "string",
          "transformationType": "string",
          "transformationName": "string",
          "properties": "string"
        }
      ],
      "passThrough": true,
      "outboundConnections": [
        {
          "adapterType": "string",
          "useProcessLock": true,
          "wrapperType": 0,
          "mightBeWrapped": true,
          "adapterId": "string",
          "adapterName": "string",
          "connectionProperties": "string",
          "ackOptions": {
            "sendAck": true,
            "adapterType": "string",
            "connectionProperties": "string",
            "transformationSasUri": "string",
            "transformationId": "string",
            "transformationVersion": "string",
            "ackOutboundFormat": "string",
            "useZipMapping": true,
            "sendNegativeAck": true,
            "dllFileNameWithExtension": "string"
          },
          "condition": {
            "enabled": true,
            "expression": "string"
          },
          "intervalOptions": {
            "useInterval": true,
            "pollingIntervalInSeconds": 0,
            "intervalExpression": "string",
            "retryOptions": {
              "failureRetryIntervalSeconds": 0,
              "turnOffFailureRetry": true,
              "retryOnNonTransientFailures": true
            }
          }
        }
      ],
      "messageOutboundFormat": "string",
      "messageOutboundEncoding": "string",
      "internalProperties": {
        "redirectInboundToRetry": true,
        "redirectBatchingToRetry": true,
        "redirectSplittingToRetry": true
      },
      "enabled": true,
      "preDefinedUserProperties": {},
      "condition": {
        "enabled": true,
        "expression": "string"
      }
    }
  ],
  "companyName": "string",
  "companyId": "string",
  "subscriptionName": "string",
  "subscriptionId": "string",
  "transactionType": "string",
  "loggingWebhooks": [
    {
      "contract": 0,
      "endpointURL": "string",
      "httpVerb": "string",
      "webhookConnectionId": "string",
      "adapterType": 0,
      "queryString": "string",
      "maxRetries": 0,
      "timeout": 0,
      "authorizationHeaderKey": {
        "decryptedValue": "string",
        "name": "string",
        "version": "string"
      },
      "type": 0,
      "enabled": true,
      "headers": {},
      "logLevel": 0,
      "inboundMesssageType": "string",
      "outboundMessageType": "string",
      "logMessageContent": true,
      "transactionTag": "string",
      "customInboundDescription": "string",
      "customOutboundDescription": "string",
      "logMetaData": true,
      "useExternalContentService": true,
      "sendContentOnExternalServiceFailure": true,
      "externalContentServiceWebhook": {
        "endpointURL": "string",
        "httpVerb": "string",
        "webhookConnectionId": "string",
        "authorizationHeaderType": "string",
        "apimSubscriptionKey": {
          "decryptedValue": "string",
          "name": "string",
          "version": "string"
        },
        "oAuthUrl": "string",
        "oAuthBody": "string",
        "oAuthClientId": "string",
        "oAuthClientSecret": {
          "decryptedValue": "string",
          "name": "string",
          "version": "string"
        },
        "headers": {},
        "body": "string",
        "usePaging": true,
        "useDateDelta": true,
        "pagingType": 0,
        "nextLinkType": 0,
        "pathName": "string",
        "oAuthGrantType": "string",
        "oAuthUserName": "string",
        "oAuthPwd": {
          "decryptedValue": "string",
          "name": "string",
          "version": "string"
        },
        "oAuthResource": "string",
        "oAuthScope": "string",
        "customAuthenticationProperties": {},
        "basicAuthenticationUserName": "string",
        "basicAuthenticationPassword": {
          "decryptedValue": "string",
          "name": "string",
          "version": "string"
        },
        "newInternalMessageCorrelationId": "string",
        "newInternalMessagePreserveInterchangeId": true,
        "useFallBackOnRequestFailed": true,
        "fallBackOnThreeHoundred": true,
        "fallBackOnFourHoundred": true,
        "fallBackOnFiveHoundred": true,
        "useStaticIp": true,
        "terminateOnDuplicateDetection": true,
        "duplicateTerminationStatus": "string",
        "restResponseErrorHandlingRules": [
          {
            "statusCodes": "string",
            "action": 0,
            "retry": true,
            "customStatus": "string"
          }
        ],
        "customTimeout": 0,
        "useCustomTokenHeader": true,
        "customTokenHeader": {
          "key": "string",
          "value": "string"
        }
      }
    }
  ],
  "resendWebhooks": [
    {
      "contract": 0,
      "endpointURL": "string",
      "httpVerb": "string",
      "webhookConnectionId": "string",
      "adapterType": 0,
      "queryString": "string",
      "maxRetries": 0,
      "timeout": 0,
      "authorizationHeaderKey": {
        "decryptedValue": "string",
        "name": "string",
        "version": "string"
      },
      "type": 0,
      "enabled": true,
      "headers": {},
      "usePureMessageSending": true
    }
  ],
  "internalLoggingOptions": {
    "logLevel": 0,
    "logMessageContent": true,
    "logMetaData": true
  },
  "retryOptions": {
    "failureCountIntervalMinutes": 0,
    "reQueueMaxDelaySeconds": 0,
    "reQueueMinDelaySeconds": 0,
    "maxErrorsPerInterval": 0,
    "numberOfRetries": 0,
    "enabled": true,
    "turnOffErrorPersistance": true,
    "maxDelayActions": 0,
    "inboundRetryOptions": {
      "failureRetryIntervalSeconds": 0,
      "turnOffFailureRetry": true,
      "retryOnNonTransientFailures": true
    }
  },
  "sender": "string",
  "receiver": "string",
  "messageInboundFormat": "string",
  "messageInboundEncoding": "string",
  "removeBom": true,
  "handleAsBinaryFile": true,
  "internalProperties": {
    "redirectInboundToRetry": true,
    "redirectBatchingToRetry": true,
    "redirectSplittingToRetry": true
  },
  "stopOnEncodingError": true,
  "pollingIntervalInSeconds": 0,
  "intervalExpression": "string",
  "enabled": true,
  "environment": 0,
  "useApiKey": true,
  "archived": true,
  "moved": true,
  "id": "string",
  "_etag": "string",
  "cosmosEntityName": "string",
  "createdBy": "string",
  "updatedBy": "string",
  "createdAtUtc": "2024-09-27T08:40:18.496Z",
  "updatedAtUtc": "2024-09-27T08:40:18.496Z"
}

text/xml; x-api-version=1.0

Schema

Schema

configCorrelationId stringnullable
description stringnullable

inboundConnection

object

adapterType stringnullable

useProcessLock boolean

wrapperType int32

Possible values: [0, 1, 2]

mightBeWrapped boolean

adapterId stringnullable

adapterName stringnullable

connectionProperties stringnullable

ackOptions

object

sendAck boolean

adapterType stringnullable

connectionProperties stringnullable

transformationSasUri stringnullable

transformationId stringnullable

transformationVersion stringnullable

ackOutboundFormat stringnullable

useZipMapping boolean

sendNegativeAck boolean

dllFileNameWithExtension stringnullable

condition

object

enabled boolean

expression stringnullable

intervalOptions

object

useInterval boolean

pollingIntervalInSeconds int32

intervalExpression stringnullable

retryOptions

object

failureRetryIntervalSeconds int32nullable

turnOffFailureRetry boolean

retryOnNonTransientFailures boolean

subIntegrations

object[]

nullable

Array [

subIntegrationId stringnullable

subintegrationName stringnullable

sender stringnullable

receiver stringnullable

loggingWebhookOverrides

object

logLevel int32

Possible values: [0, 1, 2, 3, 4]

inboundMesssageType stringnullable

outboundMessageType stringnullable

logMessageContent booleannullable

transactionTag stringnullable

customInboundDescription stringnullable

customOutboundDescription stringnullable

logMetaData booleannullable

enabled boolean

transformations

object[]

nullable

Array [

id stringnullable

transformationType stringnullable

transformationName stringnullable

properties stringnullable

]

passThrough boolean

outboundConnections

object[]

nullable

Array [

adapterType stringnullable

useProcessLock boolean

wrapperType int32

Possible values: [0, 1, 2]

mightBeWrapped boolean

adapterId stringnullable

adapterName stringnullable

connectionProperties stringnullable

ackOptions

object

sendAck boolean

adapterType stringnullable

connectionProperties stringnullable

transformationSasUri stringnullable

transformationId stringnullable

transformationVersion stringnullable

ackOutboundFormat stringnullable

useZipMapping boolean

sendNegativeAck boolean

dllFileNameWithExtension stringnullable

condition

object

enabled boolean

expression stringnullable

intervalOptions

object

useInterval boolean

pollingIntervalInSeconds int32

intervalExpression stringnullable

retryOptions

object

failureRetryIntervalSeconds int32nullable

turnOffFailureRetry boolean

retryOnNonTransientFailures boolean

]

messageOutboundFormat stringnullable

messageOutboundEncoding stringnullable

internalProperties

object

redirectInboundToRetry boolean

redirectBatchingToRetry boolean

redirectSplittingToRetry boolean

enabled boolean

preDefinedUserProperties

object

nullable

property name* string

condition

object

enabled boolean

expression stringnullable

]

companyName stringnullable
companyId stringnullable
subscriptionName stringnullable
subscriptionId stringnullable
transactionType stringnullable

loggingWebhooks

object[]

nullable

Array [

contract int32

Possible values: [0, 1]

endpointURL stringnullable

httpVerb stringnullable

webhookConnectionId stringnullable

adapterType int32

Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]

queryString stringnullable

maxRetries int32

timeout int32

authorizationHeaderKey

object

decryptedValue stringnullable

name stringnullable

version stringnullable

type int32

Possible values: [0, 1, 2, 3, 4, 5]

enabled boolean

headers

object

nullable

property name* string

logLevel int32

Possible values: [0, 1, 2, 3, 4]

inboundMesssageType stringnullable

outboundMessageType stringnullable

logMessageContent booleannullable

transactionTag stringnullable

customInboundDescription stringnullable

customOutboundDescription stringnullable

logMetaData booleannullable

useExternalContentService booleannullable

sendContentOnExternalServiceFailure booleannullable

externalContentServiceWebhook

object

endpointURL stringnullable

httpVerb stringnullable

webhookConnectionId stringnullable

authorizationHeaderType stringnullable

apimSubscriptionKey

object

decryptedValue stringnullable

name stringnullable

version stringnullable

oAuthUrl stringnullable

oAuthBody stringnullable

oAuthClientId stringnullable

oAuthClientSecret

object

decryptedValue stringnullable

name stringnullable

version stringnullable

headers

object

nullable

property name* string

body stringnullable

usePaging boolean

useDateDelta boolean

pagingType int32

Possible values: [0, 1]

nextLinkType int32

Possible values: [0, 1]

pathName stringnullable

oAuthGrantType stringnullable

oAuthUserName stringnullable

oAuthPwd

object

decryptedValue stringnullable

name stringnullable

version stringnullable

oAuthResource stringnullable

oAuthScope stringnullable

customAuthenticationProperties

object

nullable

property name* string

basicAuthenticationUserName stringnullable

basicAuthenticationPassword

object

decryptedValue stringnullable

name stringnullable

version stringnullable

newInternalMessageCorrelationId stringnullable

newInternalMessagePreserveInterchangeId boolean

useFallBackOnRequestFailed boolean

fallBackOnThreeHoundred boolean

fallBackOnFourHoundred boolean

fallBackOnFiveHoundred boolean

restConnectionPropertiesSecondary

useStaticIp boolean

terminateOnDuplicateDetection boolean

duplicateTerminationStatus stringnullable

restResponseErrorHandlingRules

object[]

nullable

Array [

statusCodes stringnullable

action int32

Possible values: [0, 1, 2]

retry boolean

customStatus stringnullable

]

customTimeout int32

useCustomTokenHeader booleannullable

customTokenHeader

object

key stringnullable

value stringnullable

]

resendWebhooks

object[]

nullable

Array [

contract int32

Possible values: [0, 1]

endpointURL stringnullable

httpVerb stringnullable

webhookConnectionId stringnullable

adapterType int32

Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]

queryString stringnullable

maxRetries int32

timeout int32

authorizationHeaderKey

object

decryptedValue stringnullable

name stringnullable

version stringnullable

type int32

Possible values: [0, 1, 2, 3, 4, 5]

enabled boolean

headers

object

nullable

property name* string

usePureMessageSending boolean

]

internalLoggingOptions

object

logLevel int32

Possible values: [0, 1, 2, 3, 4]

logMessageContent booleannullable

logMetaData booleannullable

retryOptions

object

failureCountIntervalMinutes int32nullable

reQueueMaxDelaySeconds int32nullable

reQueueMinDelaySeconds int32nullable

maxErrorsPerInterval int32nullable

numberOfRetries int32nullable

enabled boolean

turnOffErrorPersistance boolean

maxDelayActions int32nullable

inboundRetryOptions

object

failureRetryIntervalSeconds int32nullable

turnOffFailureRetry boolean

retryOnNonTransientFailures boolean
sender stringnullable
receiver stringnullable
messageInboundFormat stringnullable
messageInboundEncoding stringnullable
removeBom boolean
handleAsBinaryFile boolean

internalProperties

object

redirectInboundToRetry boolean

redirectBatchingToRetry boolean

redirectSplittingToRetry boolean
stopOnEncodingError boolean
pollingIntervalInSeconds int32
intervalExpression stringnullable
enabled boolean
environment int32

Possible values: [0, 1]

useApiKey boolean
archived boolean
moved boolean
id stringnullable
_etag stringnullable
cosmosEntityName stringnullable
createdBy stringnullable
updatedBy stringnullable
createdAtUtc date-timenullable
updatedAtUtc date-timenullable

Example (from schema)

{
  "configCorrelationId": "string",
  "description": "string",
  "inboundConnection": {
    "adapterType": "string",
    "useProcessLock": true,
    "wrapperType": 0,
    "mightBeWrapped": true,
    "adapterId": "string",
    "adapterName": "string",
    "connectionProperties": "string",
    "ackOptions": {
      "sendAck": true,
      "adapterType": "string",
      "connectionProperties": "string",
      "transformationSasUri": "string",
      "transformationId": "string",
      "transformationVersion": "string",
      "ackOutboundFormat": "string",
      "useZipMapping": true,
      "sendNegativeAck": true,
      "dllFileNameWithExtension": "string"
    },
    "condition": {
      "enabled": true,
      "expression": "string"
    },
    "intervalOptions": {
      "useInterval": true,
      "pollingIntervalInSeconds": 0,
      "intervalExpression": "string",
      "retryOptions": {
        "failureRetryIntervalSeconds": 0,
        "turnOffFailureRetry": true,
        "retryOnNonTransientFailures": true
      }
    }
  },
  "subIntegrations": [
    {
      "subIntegrationId": "string",
      "subintegrationName": "string",
      "sender": "string",
      "receiver": "string",
      "loggingWebhookOverrides": {
        "logLevel": 0,
        "inboundMesssageType": "string",
        "outboundMessageType": "string",
        "logMessageContent": true,
        "transactionTag": "string",
        "customInboundDescription": "string",
        "customOutboundDescription": "string",
        "logMetaData": true,
        "enabled": true
      },
      "transformations": [
        {
          "id": "string",
          "transformationType": "string",
          "transformationName": "string",
          "properties": "string"
        }
      ],
      "passThrough": true,
      "outboundConnections": [
        {
          "adapterType": "string",
          "useProcessLock": true,
          "wrapperType": 0,
          "mightBeWrapped": true,
          "adapterId": "string",
          "adapterName": "string",
          "connectionProperties": "string",
          "ackOptions": {
            "sendAck": true,
            "adapterType": "string",
            "connectionProperties": "string",
            "transformationSasUri": "string",
            "transformationId": "string",
            "transformationVersion": "string",
            "ackOutboundFormat": "string",
            "useZipMapping": true,
            "sendNegativeAck": true,
            "dllFileNameWithExtension": "string"
          },
          "condition": {
            "enabled": true,
            "expression": "string"
          },
          "intervalOptions": {
            "useInterval": true,
            "pollingIntervalInSeconds": 0,
            "intervalExpression": "string",
            "retryOptions": {
              "failureRetryIntervalSeconds": 0,
              "turnOffFailureRetry": true,
              "retryOnNonTransientFailures": true
            }
          }
        }
      ],
      "messageOutboundFormat": "string",
      "messageOutboundEncoding": "string",
      "internalProperties": {
        "redirectInboundToRetry": true,
        "redirectBatchingToRetry": true,
        "redirectSplittingToRetry": true
      },
      "enabled": true,
      "preDefinedUserProperties": {},
      "condition": {
        "enabled": true,
        "expression": "string"
      }
    }
  ],
  "companyName": "string",
  "companyId": "string",
  "subscriptionName": "string",
  "subscriptionId": "string",
  "transactionType": "string",
  "loggingWebhooks": [
    {
      "contract": 0,
      "endpointURL": "string",
      "httpVerb": "string",
      "webhookConnectionId": "string",
      "adapterType": 0,
      "queryString": "string",
      "maxRetries": 0,
      "timeout": 0,
      "authorizationHeaderKey": {
        "decryptedValue": "string",
        "name": "string",
        "version": "string"
      },
      "type": 0,
      "enabled": true,
      "headers": {},
      "logLevel": 0,
      "inboundMesssageType": "string",
      "outboundMessageType": "string",
      "logMessageContent": true,
      "transactionTag": "string",
      "customInboundDescription": "string",
      "customOutboundDescription": "string",
      "logMetaData": true,
      "useExternalContentService": true,
      "sendContentOnExternalServiceFailure": true,
      "externalContentServiceWebhook": {
        "endpointURL": "string",
        "httpVerb": "string",
        "webhookConnectionId": "string",
        "authorizationHeaderType": "string",
        "apimSubscriptionKey": {
          "decryptedValue": "string",
          "name": "string",
          "version": "string"
        },
        "oAuthUrl": "string",
        "oAuthBody": "string",
        "oAuthClientId": "string",
        "oAuthClientSecret": {
          "decryptedValue": "string",
          "name": "string",
          "version": "string"
        },
        "headers": {},
        "body": "string",
        "usePaging": true,
        "useDateDelta": true,
        "pagingType": 0,
        "nextLinkType": 0,
        "pathName": "string",
        "oAuthGrantType": "string",
        "oAuthUserName": "string",
        "oAuthPwd": {
          "decryptedValue": "string",
          "name": "string",
          "version": "string"
        },
        "oAuthResource": "string",
        "oAuthScope": "string",
        "customAuthenticationProperties": {},
        "basicAuthenticationUserName": "string",
        "basicAuthenticationPassword": {
          "decryptedValue": "string",
          "name": "string",
          "version": "string"
        },
        "newInternalMessageCorrelationId": "string",
        "newInternalMessagePreserveInterchangeId": true,
        "useFallBackOnRequestFailed": true,
        "fallBackOnThreeHoundred": true,
        "fallBackOnFourHoundred": true,
        "fallBackOnFiveHoundred": true,
        "useStaticIp": true,
        "terminateOnDuplicateDetection": true,
        "duplicateTerminationStatus": "string",
        "restResponseErrorHandlingRules": [
          {
            "statusCodes": "string",
            "action": 0,
            "retry": true,
            "customStatus": "string"
          }
        ],
        "customTimeout": 0,
        "useCustomTokenHeader": true,
        "customTokenHeader": {
          "key": "string",
          "value": "string"
        }
      }
    }
  ],
  "resendWebhooks": [
    {
      "contract": 0,
      "endpointURL": "string",
      "httpVerb": "string",
      "webhookConnectionId": "string",
      "adapterType": 0,
      "queryString": "string",
      "maxRetries": 0,
      "timeout": 0,
      "authorizationHeaderKey": {
        "decryptedValue": "string",
        "name": "string",
        "version": "string"
      },
      "type": 0,
      "enabled": true,
      "headers": {},
      "usePureMessageSending": true
    }
  ],
  "internalLoggingOptions": {
    "logLevel": 0,
    "logMessageContent": true,
    "logMetaData": true
  },
  "retryOptions": {
    "failureCountIntervalMinutes": 0,
    "reQueueMaxDelaySeconds": 0,
    "reQueueMinDelaySeconds": 0,
    "maxErrorsPerInterval": 0,
    "numberOfRetries": 0,
    "enabled": true,
    "turnOffErrorPersistance": true,
    "maxDelayActions": 0,
    "inboundRetryOptions": {
      "failureRetryIntervalSeconds": 0,
      "turnOffFailureRetry": true,
      "retryOnNonTransientFailures": true
    }
  },
  "sender": "string",
  "receiver": "string",
  "messageInboundFormat": "string",
  "messageInboundEncoding": "string",
  "removeBom": true,
  "handleAsBinaryFile": true,
  "internalProperties": {
    "redirectInboundToRetry": true,
    "redirectBatchingToRetry": true,
    "redirectSplittingToRetry": true
  },
  "stopOnEncodingError": true,
  "pollingIntervalInSeconds": 0,
  "intervalExpression": "string",
  "enabled": true,
  "environment": 0,
  "useApiKey": true,
  "archived": true,
  "moved": true,
  "id": "string",
  "_etag": "string",
  "cosmosEntityName": "string",
  "createdBy": "string",
  "updatedBy": "string",
  "createdAtUtc": "2024-09-27T08:40:18.499Z",
  "updatedAtUtc": "2024-09-27T08:40:18.499Z"
}

201

The created integration configuration

400

Request did not pass validation. Check your request and error message.

502

Could not contact internal services. Please try again later or contact our support department

Loading...