Kinesis¶

Catalyst can act as a Kinesis Source and pass events generated by Catalyst to Kinesis.

You will need to create a kinesis queue, IAM Policy and IAM User to receive Pulse events.
After creating the Kinesis, enter its relevant details in the addon configuration to start sending the events:

Configure Kinesis

Events¶

Once enabled, Pulse will relay following events to Kinesis:

Pulse Events	Trigger
pulse.install	SDK is activated for the first time on a device
pulse.track.permission	User response to location sharing
pulse.enter.region	User enters a monitored region
pulse.exit.region	User leaves a monitored region
pulse.campaign.click	User clicks the campaign
Session ID	Generated by the SDK as per its configuration

Events properties depend on the context in which the event is generated and the data available from the device.

Below is the JSON schema for reference:

pulse.install¶

{
    "device_uagent": "android",
    "event": "pulse.install",
    "event_id": "2cea03cd-7d74-4ef0-8d0c-99bef9a78f81",
    "event_origin_id": 786186172,
    "event_origin_name": "Mocha_Test",
    "event_utc": "2018-11-02 02:41:41",
    "event_version": "1.0",
    "session": "00000000000000000000011111231523"
}

pulse.track.permission¶

{
    "device_uagent": "android",
    "event": "pulse.track.permission",
    "event_id": "39a994f3-a004-4684-82e8-70cd58cb1c77",
    "event_origin_id": 786186172,
    "event_origin_name": "Mocha_Test",
    "event_utc": "2018-11-02 02:41:43",
    "event_version": "1.0",
    "location_perm": 1,
    "session": "00000000000000000000011111231523"
}

Geofence: pulse.enter.region¶

{
    "app_active": 1,
    "campaign_content": "",
    "campaign_event_id": "",
    "campaign_id": 0,
    "campaign_notification": "",
    "campaign_type": "",
    "device_accuracy": 5,
    "device_altitude": 0,
    "device_heading": "0",
    "device_id": 452,
    "device_latitude": -37.81244944337372,
    "device_longitude": 144.9628322944427,
    "device_speed": -1,
    "device_timestamp": 1541126517547,
    "device_tz": "Australia/Melbourne",
    "device_uagent": "android",
    "entered_on": "2018-11-02 13:41:34",
    "event": "pulse.enter.region",
    "event_id": "272f69e9-e0ab-4659-8c3d-93dfff9c4b15",
    "event_origin_id": 786186172,
    "event_origin_name": "Mocha_Test",
    "event_trigger": "geofence",
    "event_utc": "2018-11-02 02:41:58",
    "event_version": "1.0",
    "location_id": 0,
    "location_name": "",
    "location_perm": 1,
    "location_ref": "",
    "location_tags": "",
    "profile_segments": null,
    "session": "00000000000000000000011111231523"
}

Geofence: pulse.exit.region¶

{
    "app_active": 1,
    "campaign_content": "",
    "campaign_event_id": "",
    "campaign_id": 0,
    "campaign_notification": "",
    "campaign_type": "",
    "device_accuracy": 5,
    "device_altitude": 0,
    "device_heading": "0",
    "device_id": 0,
    "device_latitude": -37.81244944337372,
    "device_longitude": 144.9628322944427,
    "device_speed": -1,
    "device_timestamp": 1541126518777,
    "device_tz": "Australia/Melbourne",
    "device_uagent": "android",
    "event": "pulse.exit.region",
    "event_id": "272f69e9-e0ab-4659-8c3d-93dfff9c4b15",
    "event_origin_id": 786186172,
    "event_origin_name": "Mocha_Test",
    "event_trigger": "geofence",
    "event_utc": "2018-11-02 02:41:59",
    "event_version": "1.0",
    "exited_on": "2018-11-02 13:41:34",
    "geofence_id": "00000000000000000000000000000000",
    "location_id": 0,
    "location_name": "",
    "location_perm": 1,
    "location_ref": "",
    "location_tags": "",
    "profile_segments": null,
    "session": "00000000000000000000011111231523"
}

Beacon: pulse.enter.region¶

{
    "app_active": 1,
    "bmajorid": 1,
    "bminorid": 1,
    "buuid": "15ee2483-ff54-4350-9f0c-0349f3376be6",
    "campaign_content": "",
    "campaign_event_id": "",
    "campaign_id": 0,
    "campaign_notification": "",
    "campaign_type": "",
    "device_accuracy": 5,
    "device_altitude": 0,
    "device_heading": "0",
    "device_id": 452,
    "device_latitude": -37.81244944337372,
    "device_longitude": 144.9628322944427,
    "device_speed": -1,
    "device_timestamp": 1541126520006,
    "device_tz": "Australia/Melbourne",
    "device_uagent": "android",
    "entered_on": "2018-11-02 13:41:34",
    "event": "pulse.enter.region",
    "event_id": "41be8752-b3e2-481b-8497-2564c0a0663c",
    "event_origin_id": 786186172,
    "event_origin_name": "Mocha_Test",
    "event_trigger": "beacon",
    "event_utc": "2018-11-02 02:42:00",
    "event_version": "1.0",
    "location_id": 0,
    "location_name": "",
    "location_perm": 1,
    "location_ref": "",
    "location_tags": "",
    "profile_segments": null,
    "session": "00000000000000000000011111231523"
}

Beacon: pulse.exit.region¶

{
    "app_active": 1,
    "bmajorid": 1,
    "bminorid": 1,
    "buuid": "15ee2483-ff54-4350-9f0c-0349f3376be6",
    "campaign_content": "",
    "campaign_event_id": "",
    "campaign_id": 0,
    "campaign_notification": "",
    "campaign_type": "",
    "device_accuracy": 5,
    "device_altitude": 0,
    "device_heading": "0",
    "device_id": 0,
    "device_latitude": -37.81244944337372,
    "device_longitude": 144.9628322944427,
    "device_speed": -1,
    "device_timestamp": 1541126521132,
    "device_tz": "Australia/Melbourne",
    "device_uagent": "android",
    "event": "pulse.exit.region",
    "event_id": "41be8752-b3e2-481b-8497-2564c0a0663c",
    "event_origin_id": 786186172,
    "event_origin_name": "Mocha_Test",
    "event_trigger": "beacon",
    "event_utc": "2018-11-02 02:42:02",
    "event_version": "1.0",
    "exited_on": "2018-11-02 13:41:34",
    "location_id": 0,
    "location_name": "",
    "location_perm": 1,
    "location_ref": "",
    "location_tags": "",
    "profile_segments": null,
    "session": "00000000000000000000011111231523"
}

Campaigns¶

A Campaign can be triggered on both enter and exit events. If triggered, campaign details can be accessed from campaign properties which will be available in the event:

{
    "app_active": 0,
    "bmajorid": 1,
    "bminorid": 1,
    "buuid": "15ee2483-ff54-4350-9f0c-0349f3376be6",
    "campaign_content": "",
    "campaign_event_id": "c4c61277-153b-4a3f-a3b2-3b0286b52436",
    "campaign_id": 2419,
    "campaign_notification": "",
    "campaign_type": "url",
    "device_accuracy": 5,
    "device_altitude": 0,
    "device_heading": "0",
    "device_id": 452,
    "device_latitude": 0,
    "device_longitude": 0,
    "device_speed": -1,
    "device_timestamp": 1541126536625,
    "device_tz": "Australia/Melbourne",
    "device_uagent": "android",
    "event": "pulse.exit.region",
    "event_id": "641d7827-b132-4b97-8749-4dd6b7679283",
    "event_origin_id": 786186172,
    "event_origin_name": "Mocha_Test",
    "event_trigger": "beacon",
    "event_utc": "2018-11-02 02:42:17",
    "event_version": "1.0",
    "exited_on": "2018-11-02 13:41:34",
    "location_id": 0,
    "location_name": "",
    "location_perm": 1,
    "location_ref": "",
    "location_tags": "",
    "profile_segments": null,
    "session": "00000000000000000000011111231523"
}

pulse.campaign.click¶

{
    "event": "pulse.campaign.click",
    "event_id": "60886015800661501d9f14005b517827",
    "event_origin_id": 786186172,
    "event_origin_name": "Mocha_Test",
    "event_utc": "2018-11-15 05:53:41",
    "event_version": "1.0",
    "session": "00000000000000000000000000231513"
}