ONARKEN® Webhook Documentation

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.