Notifications

To receive ONARKEN® update notifications, simply go to the sidebar, go to the bottom section, and click the 'Keep up to date' button with the bell icon. 

You will then see this pop-up. 

Read and confirm you agree with the terms and conditions, and then press 'Subscribe me'. 

You will then receive regular email communications, with news about the ONARKEN® platform. 

You are free to update your notification preferences or unsubscribe you will see a link to do this at the bottom of each email that you receive from ONARKEN® Updates.

To see a full overview of notification features in ONARKEN®, please read the ONARKEN® Notifications Overview

If you wish to configure email notifications for end users, go to this article: How do I Enable & Customise Email Notifications for End Users? 

When an issue occurs with a transaction or at a smart locker that requires manual intervention, it is important that your IT staff in your organisation are made aware as soon as possible.  You can receive automated admin notifications about your LapSafe® smart locker and vending machine installations directly from automated emails. 

Configuration

The following events can be reported by email notification to ONARKEN administrators and staff users when:

• Locker doors are left open for longer than 30 seconds 
• Installations lose connection to ONARKEN
• Faulty bays are reported by the ONARKEN client
• When loaned assets are not returned correctly
• When locker bays enter quarantine
• When fault reports are logged on returned assets
• When returned assets require a manual review, if the AI camera cannot determine the returned asset
• When asset drop-offs fail
• When asset collections fail
• When asset swaps fail

Setup

To set up admin notifications in an email channel, follow the guide below:

Example Notifications

Admin email notifications can be read easily on PC and mobile. 

Configuring an End User Notification

Every end-user notification has a configurable 'subject' and 'body' field, along with several custom variables. Each end-user notification has a pre-configured template already saved, so you can use this feature as-is if you prefer.

If you wish to configure ONARKEN® notifications for administrators, please see our guide - How can I configure Admin Email notifications in ONARKEN®?

When you click the 'Notifications' button on the sidebar, you will be taken to the end-user notifications page. 

For this example, we will be configuring the "Your loan returned confirmation" notification. You can see this template below.

To select this template, click the 'Your loan return confirmation' from the 'Loaning' section of the drop-down menu.

The default text for this template reads as follows:

Select the subject and content textboxes, and then type to change the content that will be sent in the email. The selected textbox will have a blue outline. 

To copy a variable, go to the variables section and click the 'copy' button to the right of the variable name. 

Go back to the body or subject fields, and press ctrl+V, or right click, and select paste.

For this example, I have changed the template text to the following. You can change the notification text to whatever you wish. 

To enable the notification to be sent to your users. Toggle the 'Enabled' switch.

Once you are satisfied with the changes you have made to the email template, press 'Save template'. 

Example Emails

The end user notifications will look like this to the end user. All end user notifications are mobile friendly. 

Webhook Payload Formats

Example request payloads for each webhook event can be seen below. All fields in each webhook event will be described as below. 

To learn how to set up webhooks in ONARKEN®, read this article: Configuring Webhooks for Custom Integrations

For more information on verifying received webhooks, go to  https://api.onarken.com/#webhooks

Note: drop_off.failed, collection.failed and swap.failed webhooks are only sent on Sovran smart lockers with AI asset detection features installed. 
 

Drop off completed  (drop_off.completed): 

{ 
  "event_id": "<uuid>", 
  "event_type": "drop_off.completed", 
  "event_data": { 
    "id": "<uuid>", 
    "dropped_off_at": "<dateTime>"
    } 
}

Drop off expired  (drop_off.expired):

 {
    "event_id": "<uuid>",
    "event_type": "drop_off.expired",
    "event_data": {
        "id": "<uuid>",
        "cancelled_at": "<dateTime>"
    }
}

Drop off cancelled  (drop_off.cancelled):

{
    "event_id": "<uuid>",
    "event_type": "drop_off.cancelled",
    "event_data": {
        "id": "<uuid>",
        "cancelled_at": "<dateTime>"
    }
}

Drop off failed  (drop_off.failed):

{
    "event_id": "<uuid>",
    "event_type": "drop_off.failed",
    "event_data": {
        "id": "<uuid>",
        "ai_detection": {
            "likeliness_percentage": <int>,
            "justification": "AI desciption why drop off failed",
            "detected_object": "description of unauthorised asset, or locker state"
        }
    }
}

Collection completed  (collection.completed):

{
    "event_id": "<uuid>",
    "event_type": "collection.completed",
    "event_data": {
        "id": "<uuid>",
        "dropped_off_at": "<dateTime>"
    }
}

Collection cancelled  (collection.cancelled):

{
    "event_id": "<uuid>",
    "event_type": "collection.cancelled",
    "event_data": {
        "id": "<uuid>",
        "cancelled_at": "<dateTime>"
    }
}

Collection expired  (collection.expired):

 {
    "event_id": "<uuid>",
    "event_type": "collection.expired",
    "event_data": {
        "id": "<uuid>",
        "cancelled_at": "<dateTime>"
    }
}

Collection failed  (collection.failed): 

{
    "event_id": "<uuid>",
    "event_type": "collection.failed",
    "event_data": {
        "id": "<uuid>",
        "ai_detection": {
            "likeliness_percentage": <int>,
            "justification": "Detailed AI desciption why collection failed.",
            "detected_object": "Brief description of unauthorised asset, or locker state"
        }
    }
}

Collection failed events will only trigger if the AI detects the expected asset assigned for collection still in the locker. 

Loan returned  (loan.returned):

{
    "event_id": "<uuid>",
    "event_type": "loan.returned",
    "event_data": {
        "id": "<uuid>",
        "bay_id": "<guid>",
        "asset_id": "Asset-name",
        "user_id": "<guid>",
        "requested_at": "<dateTime>",
        "loaned_at": "<dateTime>",
        "due_at": "<dateTime>",
        "returned_at": "<dateTime>,
        "cancelled_at": null
    }
}

Loan failed to return  (loan.failed_return):

{
    "event_id": "<uuid>",
    "event_type": "loan.failed_return",
    "event_data": {
        "failure_reason": "Failure reason",
        "failed_at": "<dateTime>",
        "loan": {
            "id": "<uuid>",
            "bay_id": "<guid>",
            "asset_id": "Asset-name",
            "user_id": "<guid>",
            "reason": "ai_empty",
            "loaned_at": "<dateTime>",
            "due_at": "<dateTime>",
            "cancelled_at": null
        }
    }
}

Swap completed  (swap.completed):

{
    "event_id": "<uuid>",
    "event_type": "swap.completed",
    "event_data": {
        "id": "<uuid>",
        "swapped_at": "<dateTime>"
    }
}

Swap cancelled  (swap.cancelled):

{
    "event_id": "<uuid>",
    "event_type": "swap.cancelled",
    "event_data": {
        "id": "<uuid>",
        "cancelled_at": "<dateTime>"
    }
}

Swap expired  (swap.expired):

{
    "event_id": "<uuid>",
    "event_type": "drop_off.expired",
    "event_data": {
        "id": "<uuid>",
        "cancelled_at": "<dateTime>"
    }
}

Swap failed (swap.failed)

{
    "event_id": "<uuid>",
    "event_type": "swap.failed",
    "event_data": {
        "id": "<uuid>",
        "ai_detection": {
            "likeliness_percentage": <int>,
            "justification": "Detailed AI desciption why swap failed.",
            "detected_object": "Brief description of unauthorised asset, or locker stat"
        }
    }
}

Door left open  (bay.door_left_open):

{
    "event_id": "<uuid>",
    "event_type": "bay.door_left_open",
    "event_data": {
        "id": "<uuid>",
        "opened_at": "<dateTime>"
    }
}

Bay quarantined  (bay.quarantined):

{
    "event_id": "<uuid>",
    "event_type": "bay.quarantined",
    "event_data": {
        "id": "<uuid>",
        "quarantined_at": "<dateTime>",
        "quarantined_until": "<dateTime>"
    }
}

Installation connected  (installation.connected):

{
    "event_id": "<uuid>",
    "event_type": "installation.connected",    
    "event_data": {
        "id": "<uuid>",
        "connected_at": "<dateTime>"
    }
}

Installation disconnected  (installation.disconnected):

{
    "event_id": "<uuid>",
    "event_type": "installation.disconnected",
    "event_data": {
        "id": "<uuid>",
        "disconnected_at": "<dateTime>"
    }
}

If you require any more information about processing webhooks, visit https://api.onarken.com and go to the "Webhooks" section. 

Webhooks allow us to send real time notifications of events happening on our ONARKEN® platform, straight for processing on your application or system. Webhooks allow us to send HTTP requests when events occur on ONARKEN® powered smart lockers, to your app or service. 
 

Available Webhook Endpoints

The following webhook endpoints are supported by ONARKEN®:

• Drop off completed
• Drop off expired
• Drop off cancelled
• Drop off failed*
• Collection completed 
• Collection cancelled
• Collection expired
• Collection failed
• Loan returned
• Swap completed
• Swap cancelled
• Swap expired
• Swap failed
• Installation connected
• Installation disconnected
• Door left open
• Bay quarantined
• Loan failed to return

Any combination of these notification subscriptions can be enabled. All that is required for webhooks to be enabled, is to set up a valid endpoint URL in your application to provide ONARKEN® with, and then select the subscription options you wish to receive webhook notification for. 
 

How can I Enable Webhooks?

To Enable Webhooks, follow the steps below.

Once you have set this up, ONARKEN will start sending POST requests to the provided endpoint when events occur. 
 

Request Payloads

Sample request payloads for each webhook event are viewable in ONARKEN®. You can see example webhook payloads by clicking the 'Payload Example' button for each webhook entry. A pop-up is then displayed showing a complete example payload. 

Details and full documentation for each webhook event can be found here: (Link to be provided when article published). 

If you require any more information about processing webhooks, visit https://api.onarken.com and go to the "Webhooks" section. 

Slack webhook notifications are now supported by ONARKEN®. This means that you can receive automated admin notifications about your LapSafe® smart locker and vending machine installations directly in a Slack channel or direct message chat.
 

Setting up the Application Workflow

There are two different types of workflows you can create in Slack, standard workflows and application workflows. We need to create application workflows to support incoming webhook endpoints, which are required for us to send the notifications to the channel/application. Please follow the steps below. 

Message Examples:

The ONARKEN® notifications will appear like this in Slack:

Notifications will have buttons, that will take you to the link of the loan, locker bay or installation that has sent the alert notification. 

Slack notification channels can be modified at any time on ONARKEN® once set up. 

Microsoft Teams webhook notifications using Power Automate workflows are now supported by ONARKEN®. This means that you can receive automated admin notifications about your LapSafe® smart locker and vending machine directly in a Microsoft Teams Channel or Chat. 

Note: If you are using Office 365 connectors for workflows in Teams for ONARKEN® notifications, you will need to migrate over to the new Power Automate workflows as described below. Microsoft are completely retiring Office 365 connectors with Teams on March 31, 2026. To read more, see this article: Retirement of Office 365 connectors within Microsoft Teams

Adding the Workflows app:

If you already have the Power Automate Workflows Teams application installed, you can skip this section. 

To start, you must install the Power Automate Workflows application on Teams. To do this, click the + Apps button on the sidebar. 

Search for 'Workflows' in the Teams app store. 

Make sure you install this Application. Accept the terms of use and permissions, and click 'Install'. 

Setting up the Workflow

There are many different types and templates of Workflows to choose from. You must ensure that you select the correct workflow type, otherwise Teams will not receive the notifications from ONARKEN®. Please follow the steps below. 

Message Examples:

The ONARKEN® notifications will appear like the below examples in Teams. Each message will have a button present to take the user back to the relevant page in ONARKEN®. 

Teams notification channels can be modified at any time on ONARKEN® once set up. 

Notifications have been updated with a new look, that now clearly defines the difference between 'User' and 'Admin' notifications.

To be able to enable and update any End User or Admin notifications, your user must have a role that has the permissions general.notification_templates.

To enable and update any Webhook notifications, your user must have a role that has the permission  general.webhooks

To access the notifications page, from the ONARKEN® dashboard, click the Notifications button at the bottom of the sidebar.

You will then see the Notifications Dashboard. From here you are able to access:

• End User Notifications
• Admin Notifications
• Webhooks

Notification Categories: 

End User Notifications:

These notifications are aimed at the individual users involved in a transaction. For example the user that has loaned a laptop, or a user who has arranged a transaction for another user.

They include notifications to:

• Provide receipt of transaction
• Warning of overdue or failed loans
• PIN code reminders
• Notification of available drop off bays, collections and swaps
• Notification of Hot locker assignment
• And many more...

End user notifications are sent by email, to the users email address that they were registered with on ONARKEN®. Individual notifications can be enabled or disabled. When enabled any transaction that corresponds to a notification will be sent to the user. 

After clicking the 'Notifications' button on the sidebar, you will be taken to the 'End user' tab of the notifications page. 

Each of the 'End User' notifications have a pre-configured template. These templates can be updated so the wording of the notification is more aligned with your organisations needs.

Below the text are the 'Variables' options. When added to your email template (some are already used in the default template), they display dynamic infomation about various information about the transaction, including, but not limited to:

• Smart Locker installation name
• Locker bay number
• User's name
• Time asset was loaned at

The available variables and default template change depending on the notification being edited. Every default email template uses a pre-set arrangement of variables. 

To expand a notifications category, click on the category to the left on the notifications template to expand the category and see all of the notification types. Click on the notifications category again to collapse the section.

There are 4 categories in total:

• Loaning category

•  Drop off & Collection category

• Users category

• Hot Locker category

For further information on configuring end user notifications, see this article 

How can I configure End User notifications in ONARKEN®

Admin notifications:

These are notifications that can be sent to site administrators or IT technicians. They are used to warn IT staff of events at the smart locker that require manual intervention. Examples include:

• When smart lockers go offline
• When locker bays enter quarantine
• Item return failures, due to the assets not being plugged in, or the incorrect asset being returned*
• When a fault report is submitted by an end user
• And many more...

Click the 'Admin' tab to go to the admin notifications page. The currently selected tab is highlighted pink. 

You will see a page similar to the image below. If there are no admin notifications configured. Only the 'Add notification channel' card will be displayed.

* Incorrect asset notifications can only be sent by Sovran AI lockers.

Email Notifications

To configure Email admin notifications , please see the following guide for a complete step by step process:

How can I configure Admin Email notifications in ONARKEN®

Microsoft Teams Notifications

ONARKEN can send notifications to Microsoft Teams channels and chats through webhooks

To configure Microsoft Teams notifications, please see the following guide for a complete step by step process:

Microsoft Teams Admin Notifications integration guide

Slack Notifications

To configure Slack notifications, please see the following guide for a complete step by step process:

Slack Admin Notifications integration guide 

Webhooks:

Webhooks are designed for developers to create third party integrations with ONARKEN, to receive notifications whenever events occur at ONARKEN® powered smart lockers.

Click the 'Webhooks' tab to go to the admin notifications page. The currently selected tab is highlighted pink. 

To set up webhooks in ONARKEN, please follow this guide  

Configuring Webhooks for Custom Integrations

ONARKEN displays visual locker maps of your smart kiosks, whcih provide you an easy way to manage your installations at a glance. These locker maps update constantly, and several different colour displays are used to indicate the status of locker bays within your smart locker installations. This guide is to provide explanations for each colour-coded status. 

Locker maps are a visual UI representation of your smart locker layouts displayed on the ONARKEN dashboard. Colour statuses are displayed on locker bays to give admins an easy way of distinguishing what the status of the bay is. 

Loan lockers: 

* Only displays for lockers with AI detection enabled. 

Hot lockers:

Drop off & Collection lockers:

† This colour is used when no reason for drop off is stated. 

Generic statuses:

‡ Only displays for bays with SmartLine™ charge functionality. 

Note: There is an issue with some colour displays not flashing when viewed in Firefox. This is not a fault with the ONARKEN software.

It’s crucial to ensure you and your team are promptly notified when a locker door is left open, as valuable assets inside could be at risk. ONARKEN allows you to configure notifications via Email or Microsoft Teams to alert you if a door remains open for more than 2 minutes.

Follow these steps to configure notification subscriptions:

1. Log in to your ONARKEN account.
   Use your administrator credentials to access the platform.
   
   

2. Access the Notifications section.
   From the main navigation menu, click Notifications.
   
   

3. Add a new notification configuration.
   In the Admin Notifications section, click the Add button.
   
   

4. Select your notification channel.
   Choose your preferred notification method—Email or Microsoft Teams.
   
   

5. Provide the required details.

   • For Email: Enter your email address.
   • For Microsoft Teams: Enter the webhook URL for your Teams channel.
     
     

6. Choose the notification type.
   From the Subscriptions dropdown, select Doors Left Open.
   
   

7. Select the applicable Smart Lockers.
   For each Smart Locker you wish to monitor, check the corresponding checkbox.
   
   

8. Save your configuration.
   Click Add Configuration to finalise your notification setup.

Once these steps are completed, you’ll receive a notification if a locker door remains open for longer than 2 minutes, helping you address potential risks promptly.