User events

Inform the Copilot.cx system of events related to the user.

Please refer the user_id and thing_id best practices here.

User Created

Notify Copilot.cx that a User was created in your system. Use this when a new user is registered/created in your system.

• Type: 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_offest	String	Representing the time difference from utc. Values range: -1200 to +1459 ( format [+/-]HHMM diff from UTC) OR Z OR 0000
custom_properties	Dictionary	Custom properties or attributes for a given user

• Example

  {
    "events": [
      {
        "type": "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",
          "custom_properties": {
            "subscription": "premium",
            "is_user_external": true,
            "category": 5
          }
        }
      }
    ]
  }
  

---

User Updated

Notifies Copilot.cx that a user was updated in your system.

• Type: user_updated

• 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_offest	String	Representing the time difference from utc. Values range: -1200 to +1459 ( format [+/-]HHMM diff from UTC) OR Z OR 0000
custom_properties	Dictionary	Custom properties or attributes for a given user

• Example

  {
    "events": [
      {
        "type": "user_updated",
        "event_id": "e8cd902a-72e4-4604-82df-87fd136e12e9",
        "timestamp": 1559570980484,
        "payload": {
          "first_name": "Michael",
          "last_name": "Smith",
          "user_id": "7d979525-82d6-4e66-ac24-936d523340b9",
          "copilot_analysis_consent": true,
          "utc_offset": "-0500",
          "custom_properties": {
            "is_imported": true,
            "imported_before_seconds": 10,
            "type": "expert"
          }
        }
      }
    ]
  }
  

User Deleted

Notify Copilot.cx that a User was deleted in your system. Post this event when user asks to be deleted from your system.

• Type: user_deleted

• Payload fields:

Field	Type	Description	Mandatory
user_id	String	Your unique user identifier to delete	Y

• Example

  {
  "events": [
    {
      "type": "user_deleted",
      "event_id": "5139f606-a47b-45b9-8fa2-20d1576950bf",
      "timestamp": 1559570628993,
      "payload": {
        "user_id": "325ca496-afe8-4f44-bd37-b0dc90bdfdea"
      }
    }
  ]
}