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.