Notification callback

On this page, you will find the JSON schema for Geofencing API notification callback. Its purpose is to monitor changes made to the Geofencing API subscriptions, such as creation, modification or termination. Underneath the JSON schema, there is a table with further information on the specific keyword values.

Remember that the string values represented below are just examples that can be used. So, they should contain your real monitored device values.

Subscription notification callback

{
    "id": "123456",
    "source": "https://notificationServer12345.enterprise.com",
    "type": "org.camaraproject.geofencing.v0.area-entered",
    "specversion": "1.0",
    "datacontenttype": "application/json",
    "time": "2023-01-11T11:53:20.293671Z",
    "data": {
        "subscriptionId": 123456789,
        "device": {
            "phoneNumber": 987654321
        },
        "area": {
            "areaType": "CIRCLE",
            "center": {
                "latitude": 51.123456,
                "longitude": 6.12345
            },
            "radius": 1000
        }
    }
}

Keyword values	Description
`id`	A string value with the event subscription identifier.
`source`	A string value that identifies the source where the event happened. It contains the Network as Code API implementation and subscription ID.
`type`	A string value returned by the API with different statuses.
`specversion`	A string representing the specification version.
`datacontenttype`	A string indicating the media type for the event payload encoding. It must be "application/json" in the context of CAMARA Project APIs
`time`	A string value with the time the event occurred. Date and time are specified in ISO 8601 format, e.g.: `2023-08-20T21:01:02.345Z`.
`data`	An object that will contain other objects or strings, such as subscription ID and device data.
`subscriptionId`	A string with the subscription ID, which can be used later to unsubscribe from notifications or get a subscription by its ID.
`device`	An object that is returned with the device details
`phoneNumber`	An integer value that is returned with the device phone number.
`area`	An object defining the geofenced area, which contains the area type and geographic coordinates for latitude, longitude and radius.
`areaType`	A string value with the area type, which should be `CIRCLE`
`center`	An object defining the location in a map with coordinates, which should contain integer values for `latitude` and `longitude`.
`radius`	An integer value defining the expected accuracy for the geofencing subscription in meters.

Last updated on May 21, 2024