Notification Center

Introduction

Our Notification Center keeps you informed about relevant events within our platform. The feature allows you to configure email notifications for specific events generated by our software:

• Incoming orders: Get emails for incoming orders. Choose the facility you are interested in or receive emails for all incoming orders.

• Unroutable orders: Get notified if an order could not be assigned to a facility.

Configuration

To set up notifications, you need to put a corresponding configuration in place. The notification configuration has the following attributes:

• channels: A channel defines the source and the target of notifications. We recommend to define different channels for different receiver groups and/or facilities. See below for a detailed description.

• enabled: Defines the state of the channel. Set to true if notifications should be sent and to false if notifications should be paused.

A channel is a JSON Object which contains the following attributes:

• type: The type of the notification you will receive. Currently, only EMAIL is supported.

• events: The events upon which the notification is triggered. Currently we support:

  • PICK_JOB_CREATED: An order was assigned to a facility and is ready to be picked.

  • ROUTING_PLAN_NOT_ROUTABLE: An order could not be assigned to a facility and is in "unroutable" state.

• receiver: Who will receive the notification. This is an array of objects. The attributes of the objects change based on the TYPE:

  • Type EMAIL:

    • email: The email address of the recipient

    • language: The language of the email. Currently, this is either de_DE or en_US. It is possible to define a different language for each receiver email address.

You can define, whether you want to receive notifications on network level or only for specific facilities.

Configuration on network level

Create a new configuration

Create a configuration on network level if you want to receive notifications globally, i.e. for all events no matter which facility they apply to. To create a new configuration on network level, use the below endpoint to create one or several channel(s). If you want to send the same events to the same user group, it is sufficient to create one channel. Please speficy type, event(s), and receiver(s) as specified above and set enabled to true.

Creates or updates an existing notification center configuration.

PUT/api/configurations/notifications

Body

application/json

one of

NotificationCenterConfigForUpdate (object)object

Response

200201400401403409

Notification center configuration was successfully updated.

Body

application/json

version*number

created*string (date-time)

lastModified*string (date-time)

channels*array of one of

Request

JavaScriptCurl

const response = await fetch('/api/configurations/notifications', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "channels": [
        {
          "enabled": false,
          "events": [
            "PICK_JOB_CREATED"
          ],
          "type": "text",
          "receiver": [
            {
              "email": "[e-mail]",
              "language": "de_DE"
            }
          ]
        }
      ],
      "version": 0
    }),
});
const data = await response.json();

Response

{
  "version": 0,
  "created": "2024-04-29T05:39:05.365Z",
  "lastModified": "2024-04-29T05:39:05.365Z",
  "channels": [
    {
      "enabled": false,
      "events": [
        "PICK_JOB_CREATED"
      ],
      "type": "text",
      "id": "text",
      "receiver": [
        {
          "email": "[e-mail]",
          "language": "de_DE"
        }
      ]
    }
  ]
}

Add a new channel or update an existing channel

Executes an action to manipulate the notification center configuration.

POST/api/configurations/notifications/actions

Body

application/json

one of

AddChannelAction (object)UpdateChannelByIdAction (object)

Response

200400401403409

Notification center configuration action was successfully executed.

Body

application/json

version*number

created*string (date-time)

lastModified*string (date-time)

channels*array of one of

Request

JavaScriptCurl

const response = await fetch('/api/configurations/notifications/actions', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "ADD_CHANNEL",
      "channel": {
        "enabled": false,
        "events": [
          "PICK_JOB_CREATED"
        ],
        "type": "text",
        "receiver": [
          {
            "email": "[e-mail]",
            "language": "de_DE"
          }
        ]
      },
      "version": 0
    }),
});
const data = await response.json();

Response

{
  "version": 0,
  "created": "2024-04-29T05:39:03.750Z",
  "lastModified": "2024-04-29T05:39:03.750Z",
  "channels": [
    {
      "enabled": false,
      "events": [
        "PICK_JOB_CREATED"
      ],
      "type": "text",
      "id": "text",
      "receiver": [
        {
          "email": "[e-mail]",
          "language": "de_DE"
        }
      ]
    }
  ]
}

Get configuration information

Returns the notification center configuration.

GET/api/configurations/notifications

Response

200401403404

The notification center configuration was successfully returned.

Body

application/json

version*number

created*string (date-time)

lastModified*string (date-time)

channels*array of one of

Request

JavaScriptCurl

const response = await fetch('/api/configurations/notifications', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "version": 0,
  "created": "2024-04-29T05:39:03.750Z",
  "lastModified": "2024-04-29T05:39:03.750Z",
  "channels": [
    {
      "enabled": false,
      "events": [
        "PICK_JOB_CREATED"
      ],
      "type": "text",
      "id": "text",
      "receiver": [
        {
          "email": "[e-mail]",
          "language": "de_DE"
        }
      ]
    }
  ]
}

Delete a channel

Deletes a notification center config channel.

DELETE/api/configurations/notifications/channels/{channelId}

Path parameters

channelId*string

Query parameters

Response

200400401403404409

Notification center config channel was successfully deleted.

Request

JavaScriptCurl

const response = await fetch('/api/configurations/notifications/channels/{channelId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Configurations on facility level

Create a new configuration

Create a configuration on facility level if you want to receive notifications only for specific facilities, e.g., only for orders that are routed to a specific facility. To create a new configuration on facility level, use the below endpoint to create one or several channel(s). If you want to send the same events to the same user group in the same facility, it is sufficient to create one channel. Please speficy facilityRef, type, event(s), and receiver(s) as specified above and set enabled to true.

Creates or updates an existing notification center facility configuration.

PUT/api/facilities/{facilityRef}/configurations/notifications

Path parameters

facilityRef*string

Body

application/json

one of

NotificationCenterConfigForUpdate (object)object

Response

200201400401403404409

Notification center facility configuration was successfully updated.

Body

application/json

version*number

created*string (date-time)

lastModified*string (date-time)

channels*array of one of

Request

JavaScriptCurl

const response = await fetch('/api/facilities/{facilityRef}/configurations/notifications', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "channels": [
        {
          "enabled": false,
          "events": [
            "PICK_JOB_CREATED"
          ],
          "type": "text",
          "receiver": [
            {
              "email": "[e-mail]",
              "language": "de_DE"
            }
          ]
        }
      ],
      "version": 0
    }),
});
const data = await response.json();

Response

{
  "version": 0,
  "created": "2024-04-29T05:39:03.750Z",
  "lastModified": "2024-04-29T05:39:03.750Z",
  "channels": [
    {
      "enabled": false,
      "events": [
        "PICK_JOB_CREATED"
      ],
      "type": "text",
      "id": "text",
      "receiver": [
        {
          "email": "[e-mail]",
          "language": "de_DE"
        }
      ]
    }
  ]
}

Add a new channel or update an existing channel

Executes an action to manipulate the notification center facility configuration.

POST/api/facilities/{facilityRef}/configurations/notifications/actions

Path parameters

facilityRef*string

Body

application/json

one of

AddChannelAction (object)UpdateChannelByIdAction (object)

Response

200400401403404409

Notification center facility configuration action was successfully executed.

Body

application/json

version*number

created*string (date-time)

lastModified*string (date-time)

channels*array of one of

Request

JavaScriptCurl

const response = await fetch('/api/facilities/{facilityRef}/configurations/notifications/actions', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "ADD_CHANNEL",
      "channel": {
        "enabled": false,
        "events": [
          "PICK_JOB_CREATED"
        ],
        "type": "text",
        "receiver": [
          {
            "email": "[e-mail]",
            "language": "de_DE"
          }
        ]
      },
      "version": 0
    }),
});
const data = await response.json();

Response

{
  "version": 0,
  "created": "2024-04-29T05:39:03.750Z",
  "lastModified": "2024-04-29T05:39:03.750Z",
  "channels": [
    {
      "enabled": false,
      "events": [
        "PICK_JOB_CREATED"
      ],
      "type": "text",
      "id": "text",
      "receiver": [
        {
          "email": "[e-mail]",
          "language": "de_DE"
        }
      ]
    }
  ]
}

Get configuration information

Returns the notification center facility configuration.

GET/api/facilities/{facilityRef}/configurations/notifications

Path parameters

facilityRef*string

Response

200401403404

The notification center facility configuration was successfully returned.

Body

application/json

version*number

created*string (date-time)

lastModified*string (date-time)

channels*array of one of

Request

JavaScriptCurl

const response = await fetch('/api/facilities/{facilityRef}/configurations/notifications', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "version": 0,
  "created": "2024-04-29T05:39:05.365Z",
  "lastModified": "2024-04-29T05:39:05.365Z",
  "channels": [
    {
      "enabled": false,
      "events": [
        "PICK_JOB_CREATED"
      ],
      "type": "text",
      "id": "text",
      "receiver": [
        {
          "email": "[e-mail]",
          "language": "de_DE"
        }
      ]
    }
  ]
}

Delete a channel

Deletes a notification center facility config channel.

DELETE/api/facilities/{facilityRef}/configurations/notifications/channels/{channelId}

Path parameters

facilityRef*string

channelId*string

Query parameters

Response

200400401403404409

Notification center facility config channel was successfully deleted.

Request

JavaScriptCurl

const response = await fetch('/api/facilities/{facilityRef}/configurations/notifications/channels/{channelId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();