Output Format

Data Broker Examples

Please expand the sections below to review examples for the message types of the Webhook service.

UDP Message
{
    "id": "1-87654321-4fff5fb82c196f3d1df7abcd",
    "type": "DATA_BROKER",
    "received": "2022-04-14T10:19:54.333Z",
    "source": "UDP",
    "device": {
        "iccid": "1234567890123456789",
        "imsi": "987654321098765",
        "ip": "127.0.0.1",
        "id": "abcdefghijABCDEFGHIJK"
    },
    "payload": {
        "type": "STRING",
        "encoding": "base64",
        "value": "RXhhbXBsZSBNZXNzYWdl"
    }
}
COAP Message
{
    "id": "1-87654321-4fff5fb82c196f3d1df7abcd",
    "type": "DATA_BROKER",
    "received": "2022-04-14T10:19:54.333Z",
    "source": "COAP",
    "device": {
        "iccid": "1234567890123456789",
        "imsi": "987654321098765",
        "ip": "127.0.0.1",
        "id": "abcdefghijABCDEFGHIJK"
    },
    "payload": {
        "type": "STRING",
        "encoding": "base64",
        "value": "RXhhbXBsZSBNZXNzYWdl",
        "topic": "exampleTopic"
    }
}
LWM2M Message
{
    "id": "1-87654321-4fff5fb82c196f3d1df7abcd",
    "type": "DATA_BROKER",
    "received": "2022-04-14T10:19:54.333Z",
    "source": "LWM2M",
    "device": {
        "iccid": "1234567890123456789",
        "imsi": "987654321098765",
        "ip": "127.0.0.1",
        "id": "abcdefghijABCDEFGHIJK"
    },
    "payload": {
        "type": "JSON",
        "value": {
            "/3441/1/1110/0": "initial value",
            "/3441/1/120": 64,
            "/3441/1/140": true,
            "/3441/1/160": 946684800000,
            "/3441/0/160": 946684800000,
            "/3441/0/140": true,
            "/3441/0/120": 64,
            "/3441/1/1160/0": 946684800000,
            "/3441/0/1160/0": 946684800000,
            "/3441/0/1140/0": true,
            "/3441/1/1120/0": 64,
            "/3441/0/1120/0": 64,
            "/3441/1/1140/0": true,
            "/3441/1/130": 3.14159,
            "/3441/1/150": "ASNFZ4mrze8=",
            "/3441/1/170": {
                "objectId": 3,
                "objectInstanceId": 0,
                "nullLink": false
            },
            "/3441/0/170": {
                "objectId": 3,
                "objectInstanceId": 0,
                "nullLink": false
            },
            "/3441/0/150": "ASNFZ4mrze8=",
            "/3441/0/130": 3.14159,
            "/3441/0/110": "initial value",
            "/3441/0/1170/0": {
                "objectId": 3,
                "objectInstanceId": 0,
                "nullLink": false
            },
            "/3441/1/1170/0": {
                "objectId": 3,
                "objectInstanceId": 0,
                "nullLink": false
            },
            "/3441/0/1150/0": "ASNFZ4mrze8=",
            "/3441/0/1110/0": "initial value",
            "/3441/1/1150/0": "ASNFZ4mrze8=",
            "/3441/0/1130/0": 3.14159,
            "/3441/1/1130/0": 3.14159,
            "/3441/1/110": "initial value"
        }
    }
}

Data Broker Message Properties

These are the properties of a data broker message. It contains parameters that help to identify the message and the device that has sent the message.

PropertyData TypeDescription
idSTRINGUnique ID for each message sent.
typeSTRINGSource event type.
Value: DATA_BROKER.
receivedSTRINGTimestamp with received message date and time in the ISO 8601 format.
sourceSTRINGValues: UDP, COAP or LWM2M.
deviceJSON ObjectObject describing device from which the message was received.
payloadJSON ObjectObject describing message payload.

Payload Properties

These are the properties of a data broker message payload object. It contains message payload properties.

PropertyData TypeDescription
typeSTRINGValues: JSON or STRING.
encodingSTRINGPresent only for UDP and COAP raw messages that hasn't been traversed through translation service.

Values: base64.
valuesee typePayload value.
topicSTRINGPresent only for COAP messages.

Device Properties

These are the properties of a data broker message device object. It contains parameters that help to identify the device that has sent the message.

PropertyData TypeDescription
iccidSTRINGDevice iccid.
imsiSTRINGDevice imsi1.
ipSTRINGDevice ip address in 1nce network.
idSTRINGDevice id in 1nce connectivity suite system.