Introduction

The system can be configured to send region entries and exits to a single URL as a post. You can configure this within the Crowd Connected console under Developer Settings. By default Region Entry Exit is switched off, so first you must enable it and then fill out the required fields, clicking save for the changes to be applied. You must choose what alias to use so that you can identify users from our internal IDs, if a device has not sent the alias then this will be blank for that user.

Events are fired when any device enters or exits any region. 

If your server is slow to respond or refuses API calls data will be dropped.

Segment Queries can also be used to send events to external systems. They enable complex logic to be performed within the system, avoiding the need to store and query the entire history of region events client-side. A segment combines multiple filters based on location history. As devices meet the segment filter rules, callbacks are sent in real-time.

Region Events

• Events are sent for every region.
• Every 60* seconds all region actions that occurred in the past 60* seconds will be sent.
• Each payload can include up to 100* region actions, multiple batches will be sent if necessary.
• For some use cases we have seen region actions peak at 100 per second.

* Subject to change

Region Event Payload (body of HTTP POST)

{
    "appKey":"APP_KEY",
    "auth":"YOUR_AUTH_KEY",
    "regionActions":[
        {
            "deviceId":"e8734a97-443b-4b84-9dbe-852bb94ffbfc",
            "alias":"ALIAS",
            "regionId":"84521fc3-cd21-42d9-aaca-2fee9eb3be26",
            "regionActionType":"ENTRY",
            "timestamp":1552910243412
        },
        {
            "deviceId":"e8734a97-443b-4b84-9dbe-852bb94ffbfc",
            "alias":"ALIAS",
            "regionId":"84521fc3-cd21-42d9-aaca-2fee9eb3be26",
            "regionActionType":"EXIT",
            "timestamp":1552910245630
        }
    ]
}