Settings / Add-ons / Configure / Segment.io

Segment.io

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

Segment provides integration to multiple destinations like CRM, Queues, Logging services and Data Warehouses.

  1. You will need to configure a Go Source to receive Pulse events.

  2. After creating the Source, enter its Write Key in the Add-on window to start sending the events:

VISA VMORC

Events

Once enabled, Pulse will relay following events to Segment:

Segment Spec Pulse Events Trigger
Identify pulse.install SDK is activated for the first time on a device
Track pulse.track.permission User response to location sharing
Track pulse.enter.region User enters a monitored region
Track pulse.exit.region User leaves a monitored region
Track pulse.campaign.click User clicks the campaign
UserID 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. This can also be accessed from Segment's Debugger interface:

pulse.install

{
  "UserId": "6342614B62FF42ACBE77E0CEDD4236A9"
}

pulse.track.permission

{
    "device_uagent": "android",
    "event_id": "9ed722a7-7784-4c7a-a8ad-acea36305ad1",
    "event_origin_id": 786186173,
    "event_origin_name": "Mocha_Test",
    "event_utc": "2018-11-01T15:53:06.000Z",
    "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": 1541127201314,
    "device_tz": "Australia/Melbourne",
    "device_uagent": "android",
    "entered_on": "2018-11-02T02:52:58.000Z",
    "event_id": "dd11ff28-f9d3-4bf9-b48d-d85c79cfe567",
    "event_origin_id": 786186173,
    "event_origin_name": "Mocha_Test",
    "event_trigger": "geofence",
    "event_utc": "2018-11-01T15:53:22.000Z",
    "event_version": "1.0",
    "geofence_id": "1B0D857E967ED57649053863D574C2F5",
    "location_id": 94793,
    "location_name": "Polygonal",
    "location_perm": 1,
    "location_ref": "",
    "location_tags": "",
    "profile_segments": nil,
    "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": 1541127202528,
    "device_tz": "Australia/Melbourne",
    "device_uagent": "android",
    "event_id": "dd11ff28-f9d3-4bf9-b48d-d85c79cfe567",
    "event_origin_id": 786186173,
    "event_origin_name": "Mocha_Test",
    "event_trigger": "geofence",
    "event_utc": "2018-11-01T15:53:23.000Z",
    "event_version": "1.0",
    "exited_on": "2018-11-02T02:52:58.000Z",
    "geofence_id": "1B0D857E967ED57649053863D574C2F5",
    "location_id": 94793,
    "location_name": "Polygonal",
    "location_perm": 1,
    "location_ref": "",
    "location_tags": "",
    "profile_segments": nil,
    "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": 1541127203757,
    "device_tz": "Australia/Melbourne",
    "device_uagent": "android",
    "entered_on": "2018-11-02T02:52:58.000Z",
    "event_id": "0d5e5a4d-910f-4d11-91a7-5f4c7f3d9635",
    "event_origin_id": 786186173,
    "event_origin_name": "Mocha_Test",
    "event_trigger": "beacon",
    "event_utc": "2018-11-01T15:53:24.000Z",
    "event_version": "1.0",
    "location_id": 94793,
    "location_name": "Polygonal",
    "location_perm": 1,
    "location_ref": "",
    "location_tags": "",
    "profile_segments": nil,
    "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": 1541127204988,
    "device_tz": "Australia/Melbourne",
    "device_uagent": "android",
    "event_id": "0d5e5a4d-910f-4d11-91a7-5f4c7f3d9635",
    "event_origin_id": 786186173,
    "event_origin_name": "Mocha_Test",
    "event_trigger": "beacon",
    "event_utc": "2018-11-01T15:53:25.000Z",
    "event_version": "1.0",
    "exited_on": "2018-11-02T02:52:58.000Z",
    "location_id": 94793,
    "location_name": "Polygonal",
    "location_perm": 1,
    "location_ref": "",
    "location_tags": "",
    "profile_segments": nil,
    "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,
    "campaign_content": "",
    "campaign_event_id": "df0a13c6-4e35-4a16-a17c-ee73fffe33ab",
    "campaign_id": 2431,
    "campaign_notification": "",
    "campaign_type": "url",
    "device_accuracy": 5,
    "device_altitude": 0,
    "device_heading": "0",
    "device_id": 452,
    "device_latitude": -37.8394457,
    "device_longitude": 144.9990706,
    "device_speed": -1,
    "device_timestamp": 1541127210824,
    "device_tz": "Australia/Melbourne",
    "device_uagent": "android",
    "entered_on": "2018-11-02T02:52:58.000Z",
    "event_id": "17f44041-fefd-40b3-b653-56672dff9a68",
    "event_origin_id": 786186173,
    "event_origin_name": "Mocha_Test",
    "event_trigger": "geofence",
    "event_utc": "2018-11-01T15:53:31.000Z",
    "event_version": "1.0",
    "geofence_id": "1B0D857E967ED57649053863D574C2F5",
    "location_id": 94793,
    "location_name": "Polygonal",
    "location_perm": 1,
    "location_ref": "",
    "location_tags": "",
    "profile_segments": {
      "age": 35,
      "gender": "female",
    },
    "session": "00000000000000000000011111231523",
}

pulse.campaign.click

{
    "event_id": "60886015800661501d9f14005b517827",
    "event_origin_id": 786186172,
    "event_origin_name": "Mocha_Test",
    "event_utc": "2018-11-14T18:53:43.000Z",
    "event_version": "1.0",
    "session": "00000000000000000000000000231513",
  }