Notification center

For detailed technical information, refer to the REST API documentation – Notification Center.

To send notifications, a notification configuration with one or more channels must be created. It is recommended to define different channels for different receiver groups or facilities.

The Notification Center supports two channel types: Email, which sends notifications to one or more recipients, and Client, which stores notifications as database entries that can be retrieved by external clients via the API.

For detailed information about channel types and use cases, refer to the Notification center product documentation.

Create a notification configuration at the network level

Create a configuration at the network level to receive notifications globally, i.e., for all events regardless of the facility they apply to.

PUT https://{YOUR-TENANT-NAME}.api.fulfillmenttools.com/api/configurations/notifications
{
  "channels": [
    {
      "enabled": true,
      "events": [
        "ROUTING_PLAN_NOT_ROUTABLE"
      ],
      "receiver": [
        {
          "email": "[email protected]",
          "language": "de_DE"
        }
      ],
      "type": "EMAIL"
    }
  ],
  "version": 1
}

Create a notification configuration at the facility level

Create a configuration at the facility level to receive notifications only for specific facilities, such as for orders that are routed to a specific facility.

PUT https://{YOUR-TENANT-NAME}.api.fulfillmenttools.com/api/facilities/{facilityRef}/configurations/notifications
{
  "channels": [
    {
      "enabled": true,
      "events": [
        "PICK_JOB_CREATED"
      ],
      "receiver": [
        {
          "email": "[email protected]",
          "language": "de_DE"
        }
      ],
      "type": "EMAIL"
    }
  ],
  "version": 1
}

Create a notification configuration for time-triggered reroute

A notification can be configured to inform a supervisor before a time-triggered reroute due to inactivity occurs.

Define when the notification is triggered

PUT https://{YOUR-TENANT-NAME}.api.fulfillmenttools.com/api/configurations/routing/reroutetimetriggered
{
  "version": 1,
  "clickAndCollectReroute": {
    "active": false,
    "rerouteTargetTimeHours": 48,
    "rerouteAfterMinutes": 120,
    "leadTimeBeforeTimeTriggeredReroute": 30
  },
  "shipFromStoreDeliveryReroute": {
    "active": false,
    "rerouteTargetTimeHours": 101,
    "rerouteAfterMinutes": 120,
    "leadTimeBeforeTimeTriggeredReroute": 30
  }
}

In this example, a task is rerouted after 120 minutes of inactivity. A notification is sent 30 minutes before the reroute occurs, which is after 90 minutes of inactivity.

Configure the notification channel

PUT https://{YOUR-TENANT-NAME}.api.fulfillmenttools.com/api/configurations/notifications
{
  "channels": [
    {
      "enabled": true,
      "events": [
        "UPCOMING_TIME_TRIGGERED_REROUTE"
      ],
      "receiver": [
        {
          "email": "[email protected]",
          "language": "de_DE"
        }
      ],
      "type": "EMAIL"
    }
  ],
  "version": 1
}

A scheduled task, known as a CRON_JOB, in the tenant is responsible for triggering the dispatch of emails. Depending on the configured interval of this job, a delay may occur between the actual event time and when the email is sent.

Last updated