Skip to main content
API docs by Redocly

Notification API (1.0)

Download OpenAPI specification:Download

License: Nexway License Version 1.0

API to send notification to customers

Notification Definitions

Get items

Authorizations:
Bearer
query Parameters
page
integer
Default: 0

Page number (zero-based)

size
integer
Default: 20

Page size (maximum 500)

sort
string

Sort order (e.g., 'createDate,desc')

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "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>
dbVersion
integer <int64>
required
object (EventMatcher)

Notification definition's eventMatcher

id
string
lastUpdateReason
string
mainIdJsonPath
required
string

Notification definition's main json path

name
required
string

Notification definition's name

required
object (NotificationPayload)

Notification definition's payload

originalId
string
updateDate
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "createDate": "2019-08-24T14:15:22Z",
  • "dbVersion": 0,
  • "eventMatcher": {
    },
  • "id": "string",
  • "lastUpdateReason": "string",
  • "mainIdJsonPath": "$.involved.order-v2.id",
  • "name": "Order Completed",
  • "notificationPayload": {
    },
  • "originalId": "string",
  • "updateDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "details": [
    ],
  • "error": "string",
  • "message": "string",
  • "status": 0,
  • "timestamp": 0
}

Delete item

Authorizations:
Bearer
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{ }

Get item

Authorizations:
Bearer
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "createDate": "2019-08-24T14:15:22Z",
  • "dbVersion": 0,
  • "eventMatcher": {
    },
  • "id": "string",
  • "lastUpdateReason": "string",
  • "mainIdJsonPath": "$.involved.order-v2.id",
  • "name": "Order Completed",
  • "notificationPayload": {
    },
  • "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>
dbVersion
integer <int64>
required
object (EventMatcher)

Notification definition's eventMatcher

id
string
lastUpdateReason
string
mainIdJsonPath
required
string

Notification definition's main json path

name
required
string

Notification definition's name

required
object (NotificationPayload)

Notification definition's payload

originalId
string
updateDate
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "createDate": "2019-08-24T14:15:22Z",
  • "dbVersion": 0,
  • "eventMatcher": {
    },
  • "id": "string",
  • "lastUpdateReason": "string",
  • "mainIdJsonPath": "$.involved.order-v2.id",
  • "name": "Order Completed",
  • "notificationPayload": {
    },
  • "originalId": "string",
  • "updateDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "createDate": "2019-08-24T14:15:22Z",
  • "dbVersion": 0,
  • "eventMatcher": {
    },
  • "id": "string",
  • "lastUpdateReason": "string",
  • "mainIdJsonPath": "$.involved.order-v2.id",
  • "name": "Order Completed",
  • "notificationPayload": {
    },
  • "updateDate": "2019-08-24T14:15:22Z"
}

Notifications

Get items

Authorizations:
Bearer
query Parameters
page
integer
Default: 0

Page number (zero-based)

size
integer
Default: 20

Page size (maximum 500)

sort
string

Sort order (e.g., 'createDate,desc')

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "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
{ }

Get item

Authorizations:
Bearer
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "createDate": "2019-08-24T14:15:22Z",
  • "customerId": "string",
  • "dbVersion": 0,
  • "emails": [
    ],
  • "errors": [
    ],
  • "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",
  • "notificationDefinitionId": "f98c1deb-808e-4a6d-bebd-77735593c75e",
  • "notificationReceiverId": "c9d2d1a7-4a97-4d9d-8fec-cdf258534af0",
  • "processedEvent": {
    },
  • "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
page
integer
Default: 0

Page number (zero-based)

size
integer
Default: 20

Page size (maximum 500)

sort
string

Sort order (e.g., 'createDate,desc')

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "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>
customerId
string
dbVersion
integer <int64>
emailTemplateName
string [ 10 .. 120 ] characters
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
lastUpdateReason
string
locale
string
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>
url
string

Url which receives the notification's payload

useEmailTemplate
boolean

Responses

Request samples

Content type
application/json
{
  • "createDate": "2019-08-24T14:15:22Z",
  • "customerId": "string",
  • "dbVersion": 0,
  • "emailTemplateName": "stringstri",
  • "emails": [],
  • "httpClientConfiguration": {
    },
  • "id": "string",
  • "lastUpdateReason": "string",
  • "locale": "string",
  • "name": "Order Completed Receiver",
  • "notificationDefinitionIds": [
    ],
  • "originalId": "string",
  • "status": "ACTIVE",
  • "targetedCustomerIds": [
    ],
  • "updateDate": "2019-08-24T14:15:22Z",
  • "url": "https://receiver.com",
  • "useEmailTemplate": true
}

Response samples

Content type
application/json
{
  • "details": [
    ],
  • "error": "string",
  • "message": "string",
  • "status": 0,
  • "timestamp": 0
}

Delete item

Authorizations:
Bearer
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{ }

Get item

Authorizations:
Bearer
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "createDate": "2019-08-24T14:15:22Z",
  • "customerId": "string",
  • "dbVersion": 0,
  • "emailTemplateName": "stringstri",
  • "emails": [],
  • "httpClientConfiguration": {
    },
  • "id": "string",
  • "lastUpdateReason": "string",
  • "locale": "string",
  • "name": "Order Completed Receiver",
  • "notificationDefinitionIds": [
    ],
  • "status": "ACTIVE",
  • "targetedCustomerIds": [
    ],
  • "updateDate": "2019-08-24T14:15:22Z",
  • "url": "https://receiver.com",
  • "useEmailTemplate": true
}

Update item

Authorizations:
Bearer
path Parameters
id
required
string
Request Body schema: application/json
required
createDate
string <date-time>
customerId
string
dbVersion
integer <int64>
emailTemplateName
string [ 10 .. 120 ] characters
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
lastUpdateReason
string
locale
string
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>
url
string

Url which receives the notification's payload

useEmailTemplate
boolean

Responses

Request samples

Content type
application/json
{
  • "createDate": "2019-08-24T14:15:22Z",
  • "customerId": "string",
  • "dbVersion": 0,
  • "emailTemplateName": "stringstri",
  • "emails": [],
  • "httpClientConfiguration": {
    },
  • "id": "string",
  • "lastUpdateReason": "string",
  • "locale": "string",
  • "name": "Order Completed Receiver",
  • "notificationDefinitionIds": [
    ],
  • "originalId": "string",
  • "status": "ACTIVE",
  • "targetedCustomerIds": [
    ],
  • "updateDate": "2019-08-24T14:15:22Z",
  • "url": "https://receiver.com",
  • "useEmailTemplate": true
}

Response samples

Content type
application/json
{
  • "createDate": "2019-08-24T14:15:22Z",
  • "customerId": "string",
  • "dbVersion": 0,
  • "emailTemplateName": "stringstri",
  • "emails": [],
  • "httpClientConfiguration": {
    },
  • "id": "string",
  • "lastUpdateReason": "string",
  • "locale": "string",
  • "name": "Order Completed Receiver",
  • "notificationDefinitionIds": [
    ],
  • "status": "ACTIVE",
  • "targetedCustomerIds": [
    ],
  • "updateDate": "2019-08-24T14:15:22Z",
  • "url": "https://receiver.com",
  • "useEmailTemplate": true
}