Notifications

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.

  • ROUTING_PLAN_WAITING: A routing plan is waiting

• 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.

Add link to Swagger

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 specify facilityRef, type, event(s), and receiver(s) as specified above and set enabled to true.

Add link to Swagger

Create notification before time triggered reroute is performed

Before a time triggered reroute will happen it might make sense to inform e.g., a supervisor that a reroute due to inactivity is about to happen. This might trigger an operational action like reminding the store manager to start picking.

This is how you can set up such a notification:

1. Define when the notification should be triggered

With the API call: PUT/api/configurations/routing/reroutetimetriggered you can not only set up the timespan when a task is going to be rerouted in case of inactivity but you can also set the time span how many minutes before this reroute is being performed a user should receive a notification.

This call might look like this:

{
    "version": 1,
    "clickAndCollectReroute": {
        "active": false,
        "rerouteTargetTimeHours": 48,
        "rerouteAfterMinutes": 120,
        "leadTimeBeforeTimeTriggeredReroute": 30
    },
    "shipFromStoreDeliveryReroute": {
        "active": false,
        "rerouteTargetTimeHours": 101,
        "rerouteAfterMinutes": 120,
        "leadTimeBeforeTimeTriggeredReroute": 30
    }
}

In this example it is defined that the task is being rerouted after 120 minutes of inactivity and 30 minutes before the reroute would happen (in this case after 90 minutes being inactive) a notification is sent to a defined group of people.

2. Set up the notification in the notification center

With the API call: PUT/api/configurations/notifications you can define in our notification center which addresses should receive an email if the time triggered reroute is about to happen. Therefore use the event UPCOMING_TIME_TRIGGERED_REROUTE.

This call might look like this:

{
    "channels": [
        {
            "enabled": true,
            "events": [
                "UPCOMING_TIME_TRIGGERED_REROUTE"
            ],
            "type": "EMAIL",
            "receiver": [
                {
                    "email": "PUT-IN-YOUR-EMAIL-ADDRESS",
                    "language": "de_DE"
                },
                {
                    "email": "PUT-IN-YOUR-EMAIL-ADDRESS",
                    "language": "en_US"
                }
            ]
        }
    ],
    "enabled": true,
    "version": 1
}

The set CRON_JOB in your tenant is responsible for triggering sending emails. Depending on the set intervals of this job it might be that there is a delay between the actual expiry of the previously set time and the email being sent.