Notification API (1.0)

Download OpenAPI specification:Download

API to send notification to customers

Notification Definitions

Get items

Authorizations:

Bearer

query Parameters

required	object (Pageable)
predicate required	object
target	string

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"items": [{"createDate": "2019-08-24T14:15:22Z",
"dbVersion": 0,
"eventMatcher": {"fact": "updated",
"filters": [{"jsonPath": "$.what.delta.lifeCycleStatus",
"value": "COMPLETED"
}
],
"subject": "order-v2"
},
"id": "string",
"lastUpdateReason": "string",
"mainIdJsonPath": "$.involved.order-v2.id",
"modelVersion": "string",
"name": "Order Completed",
"notificationPayload": {"content": "ORDER",
"subject": "order",
"type": "completed"
},
"updateDate": "2019-08-24T14:15:22Z"
}
],
"last": true,
"number": 0,
"size": 0,
"totalItems": 0,
"totalPages": 0
}

Create an item

Authorizations:

Bearer

Request Body schema: application/json
required

createDate	string <date-time> Deprecated
dbVersion	integer <int64>
required	object (EventMatcher) Notification definition's eventMatcher
id	string Deprecated
lastUpdateReason	string
mainIdJsonPath required	string Notification definition's main json path
modelVersion	string Deprecated
name required	string Notification definition's name
required	object (NotificationPayload) Notification definition's payload
originalId	string
updateDate	string <date-time> Deprecated

Responses

Request samples

Payload

Content type

application/json

{"createDate": "2019-08-24T14:15:22Z",
"dbVersion": 0,
"eventMatcher": {"fact": "updated",
"filters": [{"jsonPath": "$.what.delta.lifeCycleStatus",
"value": "COMPLETED"
}
],
"subject": "order-v2"
},
"id": "string",
"lastUpdateReason": "string",
"mainIdJsonPath": "$.involved.order-v2.id",
"modelVersion": "string",
"name": "Order Completed",
"notificationPayload": {"content": "ORDER",
"subject": "order",
"type": "completed"
},
"originalId": "string",
"updateDate": "2019-08-24T14:15:22Z"
}

Response samples

401
403
404
500

Content type

application/json

{"details": [{"errorType": "string",
"resourceDisplayName": "string",
"resourceId": "string",
"resourceType": "string",
"specific": { }
}
],
"error": "string",
"message": "string",
"status": 0,
"timestamp": 0
}

Get distinct values for a given field

Authorizations:

Bearer

query Parameters

target	string
required	object (Pageable)
predicate required	object

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"items": [{ }
],
"last": true,
"number": 0,
"size": 0,
"totalItems": 0,
"totalPages": 0
}

Get recap quantities for a given field

Authorizations:

Bearer

query Parameters

target required	string
required	object (Pageable)
predicate required	object

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"items": [{"count": 0,
"targetValue": "string"
}
],
"last": true,
"number": 0,
"size": 0,
"totalItems": 0,
"totalPages": 0
}

Search unwind for a given field

Authorizations:

Bearer

query Parameters

target required	string
required	object (Pageable)
predicate required	object

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"items": [{"empty": true,
"property1": { },
"property2": { }
}
],
"last": true,
"number": 0,
"size": 0,
"totalItems": 0,
"totalPages": 0
}

Delete item

Authorizations:

Bearer

path Parameters

id

required

string

Responses

Response samples

204
401
403
404
500

Content type

application/json

{ }

Get item

Authorizations:

Bearer

path Parameters

id

required

string

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"createDate": "2019-08-24T14:15:22Z",
"dbVersion": 0,
"eventMatcher": {"fact": "updated",
"filters": [{"jsonPath": "$.what.delta.lifeCycleStatus",
"value": "COMPLETED"
}
],
"subject": "order-v2"
},
"id": "string",
"lastUpdateReason": "string",
"mainIdJsonPath": "$.involved.order-v2.id",
"modelVersion": "string",
"name": "Order Completed",
"notificationPayload": {"content": "ORDER",
"subject": "order",
"type": "completed"
},
"updateDate": "2019-08-24T14:15:22Z"
}

Update item

Authorizations:

Bearer

path Parameters

id

required

string

Request Body schema: application/json
required

createDate	string <date-time> Deprecated
dbVersion	integer <int64>
required	object (EventMatcher) Notification definition's eventMatcher
id	string Deprecated
lastUpdateReason	string
mainIdJsonPath required	string Notification definition's main json path
modelVersion	string Deprecated
name required	string Notification definition's name
required	object (NotificationPayload) Notification definition's payload
originalId	string
updateDate	string <date-time> Deprecated

Responses

Request samples

Payload

Content type

application/json

{"createDate": "2019-08-24T14:15:22Z",
"dbVersion": 0,
"eventMatcher": {"fact": "updated",
"filters": [{"jsonPath": "$.what.delta.lifeCycleStatus",
"value": "COMPLETED"
}
],
"subject": "order-v2"
},
"id": "string",
"lastUpdateReason": "string",
"mainIdJsonPath": "$.involved.order-v2.id",
"modelVersion": "string",
"name": "Order Completed",
"notificationPayload": {"content": "ORDER",
"subject": "order",
"type": "completed"
},
"originalId": "string",
"updateDate": "2019-08-24T14:15:22Z"
}

Response samples

200
401
403
404
500

Content type

application/json

{"createDate": "2019-08-24T14:15:22Z",
"dbVersion": 0,
"eventMatcher": {"fact": "updated",
"filters": [{"jsonPath": "$.what.delta.lifeCycleStatus",
"value": "COMPLETED"
}
],
"subject": "order-v2"
},
"id": "string",
"lastUpdateReason": "string",
"mainIdJsonPath": "$.involved.order-v2.id",
"modelVersion": "string",
"name": "Order Completed",
"notificationPayload": {"content": "ORDER",
"subject": "order",
"type": "completed"
},
"updateDate": "2019-08-24T14:15:22Z"
}

Notifications

Get items

Authorizations:

Bearer

query Parameters

required	object (Pageable)
predicate required	object
target	string

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"items": [{"createDate": "2019-08-24T14:15:22Z",
"customerId": "string",
"dbVersion": 0,
"emails": ["string"
],
"errors": [{"error": "notification definition with id 3d5d63a9-e87e-4a68-a583-702f61a9c54c not found",
"timestamp": 1516370825
}
],
"eventFact": "updated",
"eventMainObjectId": "180119e71cfc",
"eventSubject": "order",
"id": "string",
"lastTryTimestamp": 1516370825,
"lastUpdateReason": "string",
"mailBody": "This is a body",
"mailStorageId": "36459336-730b-4951-b3d9-d03fff704b37",
"mailSubject": "Notification Order 3A8G6KR8ARY Completed",
"modelVersion": "string",
"notificationDefinitionId": "f98c1deb-808e-4a6d-bebd-77735593c75e",
"notificationReceiverId": "c9d2d1a7-4a97-4d9d-8fec-cdf258534af0",
"processedEvent": {"empty": true,
"property1": { },
"property2": { }
},
"processingDate": 1516370825,
"retryCount": 0,
"retryLeft": 10,
"status": "Done",
"updateDate": "2019-08-24T14:15:22Z",
"url": "http://receiver-url.com",
"webHookPayload": "string",
"webHookResponse": "string"
}
],
"last": true,
"number": 0,
"size": 0,
"totalItems": 0,
"totalPages": 0
}

Get distinct values for a given field

Authorizations:

Bearer

query Parameters

target	string
required	object (Pageable)
predicate required	object

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"items": [{ }
],
"last": true,
"number": 0,
"size": 0,
"totalItems": 0,
"totalPages": 0
}

Get recap quantities for a given field

Authorizations:

Bearer

query Parameters

target required	string
required	object (Pageable)
predicate required	object

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"items": [{"count": 0,
"targetValue": "string"
}
],
"last": true,
"number": 0,
"size": 0,
"totalItems": 0,
"totalPages": 0
}

Sends current entity state as a notification. Only Order is supported.

Authorizations:

Bearer

query Parameters

entityId required	string
receiverId required	string
notificationDefinitionId required	string

Responses

Response samples

Content type

application/json

{ }

Search unwind for a given field

Authorizations:

Bearer

query Parameters

target required	string
required	object (Pageable)
predicate required	object

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"items": [{"empty": true,
"property1": { },
"property2": { }
}
],
"last": true,
"number": 0,
"size": 0,
"totalItems": 0,
"totalPages": 0
}

Get item

Authorizations:

Bearer

path Parameters

id

required

string

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"createDate": "2019-08-24T14:15:22Z",
"customerId": "string",
"dbVersion": 0,
"emails": ["string"
],
"errors": [{"error": "notification definition with id 3d5d63a9-e87e-4a68-a583-702f61a9c54c not found",
"timestamp": 1516370825
}
],
"eventFact": "updated",
"eventMainObjectId": "180119e71cfc",
"eventSubject": "order",
"id": "string",
"lastTryTimestamp": 1516370825,
"lastUpdateReason": "string",
"mailBody": "This is a body",
"mailStorageId": "36459336-730b-4951-b3d9-d03fff704b37",
"mailSubject": "Notification Order 3A8G6KR8ARY Completed",
"modelVersion": "string",
"notificationDefinitionId": "f98c1deb-808e-4a6d-bebd-77735593c75e",
"notificationReceiverId": "c9d2d1a7-4a97-4d9d-8fec-cdf258534af0",
"processedEvent": {"empty": true,
"property1": { },
"property2": { }
},
"processingDate": 1516370825,
"retryCount": 0,
"retryLeft": 10,
"status": "Done",
"updateDate": "2019-08-24T14:15:22Z",
"url": "http://receiver-url.com",
"webHookPayload": "string",
"webHookResponse": "string"
}

Add retries to a notification

Authorizations:

Bearer

path Parameters

id required	string id of the notification
nbRetries required	integer <int32> [ 0 .. 20 ] number of retries

Responses

Response samples

Content type

application/json

{ }

Receivers

Get items

Authorizations:

Bearer

query Parameters

required	object (Pageable)
predicate required	object
target	string

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"items": [{"createDate": "2019-08-24T14:15:22Z",
"customerId": "string",
"dbVersion": 0,
"emails": ["[email protected]"
],
"httpClientConfiguration": {"clientCredentialOauth2Config": {"clientId": "clientIdXXXXXXXX",
"clientSecret": "secretXXXXXXXX",
"oauth2Type": "BASIC",
"scopes": ["provided"
],
"tokenUrl": "https://tokenUrl.com"
},
"httpHeaders": {"property1": ["string"
],
"property2": ["string"
]
},
"tlsConfiguration": {"clientCertificates": "-----BEGIN CERTIFICATE----- XXXX\n -----END CERTIFICATE-----",
"clientCertificatesExpirationDate": 0,
"lastCertificatesExpirationNotificationTimestamp": 0,
"privateKey": "-----BEGIN PRIVATE KEY----- XXXX\n -----END PRIVATE KEY-----",
"serverCACertificates": "-----BEGIN CERTIFICATE----- XXXX\n -----END CERTIFICATE-----",
"serverCACertificatesExpirationDate": 0,
"tlsAuthMode": "CLIENT"
}
},
"id": "string",
"lastUpdateReason": "string",
"modelVersion": "string",
"name": "Order Completed Receiver",
"notificationDefinitionIds": ["string"
],
"status": "ACTIVE",
"targetedCustomerIds": ["string"
],
"updateDate": "2019-08-24T14:15:22Z",
"url": "https://receiver.com"
}
],
"last": true,
"number": 0,
"size": 0,
"totalItems": 0,
"totalPages": 0
}

Create an item

Authorizations:

Bearer

Request Body schema: application/json
required

createDate	string <date-time> Deprecated
customerId	string
dbVersion	integer <int64>
emails	string Email which receives the notification's payload
	object (HttpClientConfig) http client configuration that may includes headers and client credential Oauth2 config
id	string Deprecated
lastUpdateReason	string
modelVersion	string Deprecated
name required	string Name of the receiver
notificationDefinitionIds	Array of strings List of notifications that receiver is listening
originalId	string
status required	string Status of the receiver ACTIVE\|INACTIVE
targetedCustomerIds	Array of strings Receiver is listening only notification from these customers
updateDate	string <date-time> Deprecated
url	string Url which receives the notification's payload

Responses

Request samples

Payload

Content type

application/json

{"createDate": "2019-08-24T14:15:22Z",
"customerId": "string",
"dbVersion": 0,
"emails": ["[email protected]"
],
"httpClientConfiguration": {"clientCredentialOauth2Config": {"clientId": "clientIdXXXXXXXX",
"clientSecret": "secretXXXXXXXX",
"oauth2Type": "BASIC",
"scopes": ["provided"
],
"tokenUrl": "https://tokenUrl.com"
},
"httpHeaders": {"property1": ["string"
],
"property2": ["string"
]
},
"tlsConfiguration": {"clientCertificates": "-----BEGIN CERTIFICATE----- XXXX\n -----END CERTIFICATE-----",
"clientCertificatesExpirationDate": 0,
"lastCertificatesExpirationNotificationTimestamp": 0,
"privateKey": "-----BEGIN PRIVATE KEY----- XXXX\n -----END PRIVATE KEY-----",
"serverCACertificates": "-----BEGIN CERTIFICATE----- XXXX\n -----END CERTIFICATE-----",
"serverCACertificatesExpirationDate": 0,
"tlsAuthMode": "CLIENT"
}
},
"id": "string",
"lastUpdateReason": "string",
"modelVersion": "string",
"name": "Order Completed Receiver",
"notificationDefinitionIds": ["string"
],
"originalId": "string",
"status": "ACTIVE",
"targetedCustomerIds": ["string"
],
"updateDate": "2019-08-24T14:15:22Z",
"url": "https://receiver.com"
}

Response samples

401
403
404
500

Content type

application/json

{"details": [{"errorType": "string",
"resourceDisplayName": "string",
"resourceId": "string",
"resourceType": "string",
"specific": { }
}
],
"error": "string",
"message": "string",
"status": 0,
"timestamp": 0
}

Get distinct values for a given field

Authorizations:

Bearer

query Parameters

target	string
required	object (Pageable)
predicate required	object

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"items": [{ }
],
"last": true,
"number": 0,
"size": 0,
"totalItems": 0,
"totalPages": 0
}

Get recap quantities for a given field

Authorizations:

Bearer

query Parameters

target required	string
required	object (Pageable)
predicate required	object

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"items": [{"count": 0,
"targetValue": "string"
}
],
"last": true,
"number": 0,
"size": 0,
"totalItems": 0,
"totalPages": 0
}

Search unwind for a given field

Authorizations:

Bearer

query Parameters

target required	string
required	object (Pageable)
predicate required	object

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"items": [{"empty": true,
"property1": { },
"property2": { }
}
],
"last": true,
"number": 0,
"size": 0,
"totalItems": 0,
"totalPages": 0
}

Delete item

Authorizations:

Bearer

path Parameters

id

required

string

Responses

Response samples

204
401
403
404
500

Content type

application/json

{ }

Get item

Authorizations:

Bearer

path Parameters

id

required

string

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"createDate": "2019-08-24T14:15:22Z",
"customerId": "string",
"dbVersion": 0,
"emails": ["[email protected]"
],
"httpClientConfiguration": {"clientCredentialOauth2Config": {"clientId": "clientIdXXXXXXXX",
"clientSecret": "secretXXXXXXXX",
"oauth2Type": "BASIC",
"scopes": ["provided"
],
"tokenUrl": "https://tokenUrl.com"
},
"httpHeaders": {"property1": ["string"
],
"property2": ["string"
]
},
"tlsConfiguration": {"clientCertificates": "-----BEGIN CERTIFICATE----- XXXX\n -----END CERTIFICATE-----",
"clientCertificatesExpirationDate": 0,
"lastCertificatesExpirationNotificationTimestamp": 0,
"privateKey": "-----BEGIN PRIVATE KEY----- XXXX\n -----END PRIVATE KEY-----",
"serverCACertificates": "-----BEGIN CERTIFICATE----- XXXX\n -----END CERTIFICATE-----",
"serverCACertificatesExpirationDate": 0,
"tlsAuthMode": "CLIENT"
}
},
"id": "string",
"lastUpdateReason": "string",
"modelVersion": "string",
"name": "Order Completed Receiver",
"notificationDefinitionIds": ["string"
],
"status": "ACTIVE",
"targetedCustomerIds": ["string"
],
"updateDate": "2019-08-24T14:15:22Z",
"url": "https://receiver.com"
}

Update item

Authorizations:

Bearer

path Parameters

id

required

string

Request Body schema: application/json
required

createDate	string <date-time> Deprecated
customerId	string
dbVersion	integer <int64>
emails	string Email which receives the notification's payload
	object (HttpClientConfig) http client configuration that may includes headers and client credential Oauth2 config
id	string Deprecated
lastUpdateReason	string
modelVersion	string Deprecated
name required	string Name of the receiver
notificationDefinitionIds	Array of strings List of notifications that receiver is listening
originalId	string
status required	string Status of the receiver ACTIVE\|INACTIVE
targetedCustomerIds	Array of strings Receiver is listening only notification from these customers
updateDate	string <date-time> Deprecated
url	string Url which receives the notification's payload

Responses

Request samples

Payload

Content type

application/json

{"createDate": "2019-08-24T14:15:22Z",
"customerId": "string",
"dbVersion": 0,
"emails": ["[email protected]"
],
"httpClientConfiguration": {"clientCredentialOauth2Config": {"clientId": "clientIdXXXXXXXX",
"clientSecret": "secretXXXXXXXX",
"oauth2Type": "BASIC",
"scopes": ["provided"
],
"tokenUrl": "https://tokenUrl.com"
},
"httpHeaders": {"property1": ["string"
],
"property2": ["string"
]
},
"tlsConfiguration": {"clientCertificates": "-----BEGIN CERTIFICATE----- XXXX\n -----END CERTIFICATE-----",
"clientCertificatesExpirationDate": 0,
"lastCertificatesExpirationNotificationTimestamp": 0,
"privateKey": "-----BEGIN PRIVATE KEY----- XXXX\n -----END PRIVATE KEY-----",
"serverCACertificates": "-----BEGIN CERTIFICATE----- XXXX\n -----END CERTIFICATE-----",
"serverCACertificatesExpirationDate": 0,
"tlsAuthMode": "CLIENT"
}
},
"id": "string",
"lastUpdateReason": "string",
"modelVersion": "string",
"name": "Order Completed Receiver",
"notificationDefinitionIds": ["string"
],
"originalId": "string",
"status": "ACTIVE",
"targetedCustomerIds": ["string"
],
"updateDate": "2019-08-24T14:15:22Z",
"url": "https://receiver.com"
}

Response samples

200
401
403
404
500

Content type

application/json

{"createDate": "2019-08-24T14:15:22Z",
"customerId": "string",
"dbVersion": 0,
"emails": ["[email protected]"
],
"httpClientConfiguration": {"clientCredentialOauth2Config": {"clientId": "clientIdXXXXXXXX",
"clientSecret": "secretXXXXXXXX",
"oauth2Type": "BASIC",
"scopes": ["provided"
],
"tokenUrl": "https://tokenUrl.com"
},
"httpHeaders": {"property1": ["string"
],
"property2": ["string"
]
},
"tlsConfiguration": {"clientCertificates": "-----BEGIN CERTIFICATE----- XXXX\n -----END CERTIFICATE-----",
"clientCertificatesExpirationDate": 0,
"lastCertificatesExpirationNotificationTimestamp": 0,
"privateKey": "-----BEGIN PRIVATE KEY----- XXXX\n -----END PRIVATE KEY-----",
"serverCACertificates": "-----BEGIN CERTIFICATE----- XXXX\n -----END CERTIFICATE-----",
"serverCACertificatesExpirationDate": 0,
"tlsAuthMode": "CLIENT"
}
},
"id": "string",
"lastUpdateReason": "string",
"modelVersion": "string",
"name": "Order Completed Receiver",
"notificationDefinitionIds": ["string"
],
"status": "ACTIVE",
"targetedCustomerIds": ["string"
],
"updateDate": "2019-08-24T14:15:22Z",
"url": "https://receiver.com"
}

Notification API (1.0)

Notification Definitions

Get items

Authorizations:

query Parameters

Responses

Response samples

Create an item

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get distinct values for a given field

Authorizations:

query Parameters

Responses

Response samples

Get recap quantities for a given field

Authorizations:

query Parameters

Responses

Response samples

Search unwind for a given field

Authorizations:

query Parameters

Responses

Response samples

Delete item

Authorizations:

path Parameters

Responses

Response samples

Get item

Authorizations:

path Parameters

Responses

Response samples

Update item

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Notifications

Get items

Authorizations:

query Parameters

Responses

Response samples

Get distinct values for a given field

Authorizations:

query Parameters

Responses

Response samples

Get recap quantities for a given field

Authorizations:

query Parameters

Responses

Response samples

Sends current entity state as a notification. Only Order is supported.

Authorizations:

query Parameters

Responses

Response samples

Search unwind for a given field

Authorizations:

query Parameters

Responses

Response samples

Get item

Authorizations:

path Parameters

Responses

Response samples

Add retries to a notification

Authorizations:

path Parameters

Responses

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required