Preexisting sync events

Preexisting sync events are used in order to inform the Copilot.cx system about the user, thing and user-thing relationship created prior Copilot.cx setup. Those events should be dispatched to Copilot.cx system in case you are already managing your users in your production environments as a syncing process that should be done only once.

Note: The relevant guidance of when and how execute the preexisting sync will be provided by the Copilot.cx team.

Please refer the user_id and thing_id best practices here.

Preexisting Sync Started

Inform Copilot.cx system that syncing of preexisting user has started.

• Type: preexisting_sync_started

• Payload fields: None

• Example

  {
    "events": [
      {
        "type": "preexisting_sync_started",
        "event_id": "d8a4ee55-da8f-4f0a-99b7-3f48629462fd",
        "timestamp": 1559570638730,
        "payload": {}
      }
    ]
  }
  

---

Preexisting Sync Completed

Inform Copilot.cx system that syncing of preexisting user was completed.

• Type: preexisting_sync_completed

• Payload fields: None

• Example

  {
    "events": [
      {
        "type": "preexisting_sync_completed",
        "event_id": "d8a4ee55-da8f-4f0a-99b7-3f48629462fd",
        "timestamp": 1559570638730,
        "payload": {}
      }
    ]
  }
  

---

Preexisting User Created

Inform Copilot.cx about a user that was created in the past.

• Type: preexisting_user_created

• Payload fields:

Field	Type	Description	Mandatory
user_id	String	Your unique User identifier	Y
first_name	String	User's first name
last_name	String	User's last name
email	String	A valid email address to be used for an engagement campaign
copilot_analysis_consent	Boolean	Is allowed to be processed (read more)
utc_offset	String	Representing the time difference from utc Values range: -1200 to +1459 ( format [+/-]HHMM diff from UTC) OR Z OR 0000
original_creation_date -	Long	If available, the date when the user was created originally, in UTC.
copilot_analysis_consent	Boolean

• Example

  {
    "events": [
      {
        "type": "preexisting_user_created",
        "event_id": "5139f606-a47b-45b9-8fa2-20d1576950be",
        "timestamp": 1559570628993,
        "payload": {
          "email": "juanita.pagac43@mailinator.com",
          "first_name": "Juanita",
          "last_name": "Pagac",
          "user_id": "325ca496-afe8-4f44-bd37-b0dc90bdfdea",
          "copilot_analysis_consent": true,
          "utc_offset": "-0500",
          "copilot_analysis_consent": true,
          "original_creation_date": 1556849038000
        }
      }
    ]
  }
  

---

Preexisting Thing Created

Inform Copilot.cx about a thing that was created in the past.

• Type: preexisting_thing_created

• Payload fields:

Field	Type	Description	Mandatory
thing_id	String	Your unique Thing identifier	Y
user_id	String	Your unique User identifier
firmware_version	String	Version of the Thing's firmware
model	String	The model of the created Thing
original_creation_date	Long	If available, the date when the Thing was created originally, in UTC.

• Example

  {
    "events": [
      {
        "type": "preexisting_thing_created",
        "event_id": "15775ead-c5d0-4894-b570-e4627e41cd78",
        "timestamp": 1559570638730,
        "payload": {
          "thing_id": "63:64:78:26:b1:c7",
          "original_creation_date": 1556849038000
        }
      }
    ]
  }
  
  

---

Preexisting User Thing Associated

Inform Copilot.cx about a thing that was associated to a user in the past.

• Type: preexisting_user_thing_associated

• Payload fields:

Field	Type	Description	Mandatory
thing_id	String	Your unique Thing identifier	Y
user_id	String	Your unique User identifier	Y
original_association_date	Long	If available, the date when the Thing and User were associated originally, in UTC.

• Example

  {
    "events": [
      {
        "type": "preexisting_user_thing_associated",
        "event_id": "d8a4ee55-da8f-4f0a-99b7-3f48629462fd",
        "timestamp": 1559570638730,
        "payload": {
          "user_id": "325ca496-afe8-4f44-bd37-b0dc90bdfdea",
          "thing_id": "63:64:78:26:b1:c7",
          "original_association_date": 1556849038000
        }
      }
    ]
  }