Documentation

Documentation

YourOwn SetupYourOwn SDKYourOwn API
Sphere SetupSphere SDKSphere API
  • Resources

›Appendix

Introduction

  • Copilot.cx Server API

Reference

  • Collect API
  • Collect payload

    • User events
    • Thing events
    • Custom events
    • Misc. events
    • Preexisting sync events
  • Consent endpoint

Appendix

  • Releases

Releases

Change log

Version 2.1.7

  • Event added:
    • User deleted

Version 2.1.6

  • Events added:
    • Unsubscribe
    • Preexisting sync started
    • Preexisting sync complete
    • Preexisting user created
    • Preexisting thing created
    • Preexisting user thing associated

Version 2.1.4

(Please refer migration guide)

  • Events added
    • Thing connected
    • Consumable usage
    • Firmware upgrade started
    • Firmware upgrade completed
  • Event changed
    • Events thing_created and thing_updated - property firmware changed to firmware_version.
    • Events user_created and user_updated - added new property utc_offset.
  • Path changes
    • Collect API path changed to /v2/collect/.
    • Consent API path changed to /v2/api/collect/.
  • Event properties restrictions:
    • Restricted to 20 properties per event.
    • Unknown properties are now allowed for events besides custom_event and thing_interaction.
  • Authentication method - Supporting Basic authentication only.

Migration guide

Please see below guidelines how to migrate between to new API versions:

Migrating from 2.1.1 to 2.1.4

General Changes

2.1.12.1.4Comments
Collect API invocation path/collect/v2/collect
Consent API invocation path/v1/api/report/v2/api/report/
Max keys(event properties) validation10020
Authentication methodBearer and BasicBasic ONLY
All events beside custom_event and thing_interactionAllowed unrecognized propertiesUnknown properties are not allowed
Allowed String charactersLimited charactersRegex: /^[a-zA-Z0-9:\-._+@]*$/first_name and last_name have limited characters

Event changes

  • Event name thing_created:
    • Property named firmware changed to firmware_version.
  • Event name thing_updated:
    • Property named firmware changed to firmware_version.
  • Event name user_created:
    • Property added:
Property nameTypeValidationIs mandatory
utc_offsetStringValues range: -1200 to +1459 ( format [+/-]HHMM diff from UTC) OR Z OR 0000false
  • Event name user_updated:
    • Property added:
Property nameTypeValidationIs mandatory
utc_offsetStringValues range: -1200 to +1459 ( format [+/-]HHMM diff from UTC) OR Z OR 0000false

New events

In version 2.1.4 new events were added. For details, please refer Thing connected, Consumable usage, Firmware upgrade started and Firmware upgrade completed events.

← Consent endpoint
  • Change log
    • Version 2.1.7
    • Version 2.1.6
    • Version 2.1.4
  • Migration guide
    • Migrating from 2.1.1 to 2.1.4
Copilot
Mail: hello@copilot.cx
Call: (212).398.0001
© Copilot.cx 2025