Notifications

Email notifications on referrals and tickets - Specify an email address to which a notification should be sent when a referral has been submitted and/or a new ticket is opened.

Webhooks - Partners can receive webhook-based notifications based on Xyte events, that allows you to connect the Xyte platform to third-party tools like ERP or CRM systems or custom servers. To enable this feature, the URL of the webhook must be set, with an required server secret for request verification on your side.
If an error is returned by the remote server, the Xyte platform will retry the call twice before failing.
Currently supported events are:
2.1. Claimed Device - When devices are claimed by end users.
The following data will be sent every time a device is claimed:

{  
     "event_type": "claimed_device",  
     "secret": "SERVER_SECRET",  
     "device_id": "DEVICE_ID",  
     "device_model_id": "DEVICE_MODEL_ID",  
     "device_model_name": "DEVICE_MODEL_NAME",  
     "claiming_organization_name": "ORGANIZATION_NAME",  
     "claiming_organization_email": "ORGANIZATION_EMAIL"  
   }

2.2. Registered Device - When devices are registered by end users.
The following data will be sent every time a device is registered:

{  
     "event_type": "registered_device",  
     "secret": "SERVER_SECRET",  
     "device_id": "DEVICE_ID",  
     "device_sn": "DEVICE_SN",  
     "device_mac": "DEVICE_MAC",  
     "device_cloud_id": "DEVICE_CLOUD_ID",  
     "device_name": "DEVICE_NAME",  
     "device_model_id": "DEVICE_MODEL_ID",  
     "device_model_name": "DEVICE_MODEL_NAME",  
     "device_firmware_version": "DEVICE_FIRMWARE_VERSION",  
     "claiming_organization_name": "ORGANIZATION_NAME",  
     "claiming_organization_display_name": "ORGANIZATION_DISPLAY_NAME"  
   }

2.3. Deleted Device - When devices are deleted by end users.
The following data will be sent every time a device is deleted:

{  
     "event_type": "deleted_device",  
     "secret": "SERVER_SECRET",  
     "device_id": "DEVICE_ID",  
     "device_sn": "DEVICE_SN",  
     "device_mac": "DEVICE_MAC",  
     "device_cloud_id": "DEVICE_CLOUD_ID",  
     "device_name": "DEVICE_NAME",  
     "device_model_id": "DEVICE_MODEL_ID",  
     "device_model_name": "DEVICE_MODEL_NAME",  
     "device_firmware_version": "DEVICE_FIRMWARE_VERSION"  
   }

2.4. Created License - When licenses are created by end users.
The following data will be sent every time a license is created:

{  
     "event_type": "created_license",  
     "secret": "SERVER_SECRET",  
     "license_product_id": "LICENSE_PRODUCT_ID",  
     "license_product_name": "LICENSE_PRODUCT_NAME",  
     "device_model_id": "DEVICE_MODEL_ID",  
     "device_model_name": "DEVICE_MODEL_NAME"  
   }

2.5. Assigned License - When licenses are assigned by end users.
The following data will be sent every time a license is assigned:

{  
     "event_type": "assigned_license",  
     "secret": "SERVER_SECRET",  
     "device_id": "DEVICE_ID",  
     "device_sn": "DEVICE_SN",  
     "device_mac": "DEVICE_MAC",  
     "device_cloud_id": "DEVICE_CLOUD_ID",  
     "device_name": "DEVICE_NAME",  
     "device_model_id": "DEVICE_MODEL_ID",  
     "device_model_name": "DEVICE_MODEL_NAME",  
     "device_firmware_version": "DEVICE_FIRMWARE_VERSION",  
     "license_product_id": "LICENSE_PRODUCT_ID",  
     "license_product_name": "LICENSE_PRODUCT_NAME",  
     "license_expires_at": "LICENSE_EXPIRES_AT"  
   }

2.6. Revoked License - When licenses are revoked by end users.
The following data will be sent every time a license is revoked:

{  
     "event_type": "revoked_license",  
     "secret": "SERVER_SECRET",  
     "device_id": "DEVICE_ID",  
     "device_sn": "DEVICE_SN",  
     "device_mac": "DEVICE_MAC",  
     "device_cloud_id": "DEVICE_CLOUD_ID",  
     "device_name": "DEVICE_NAME",  
     "device_model_id": "DEVICE_MODEL_ID",  
     "device_model_name": "DEVICE_MODEL_NAME",  
     "device_firmware_version": "DEVICE_FIRMWARE_VERSION"  
     "license_product_id": "LICENSE_PRODUCT_ID",  
     "license_product_name": "LICENSE_PRODUCT_NAME",  
     "license_expires_at": "LICENSE_EXPIRES_AT"  
   }

2.7. Updated License - When licenses are updated by end users.
The following data will be sent every time a license is updated:

{  
     "event_type": "updated_license",  
     "secret": "SERVER_SECRET",  
     "device_id": "DEVICE_ID",  
     "device_sn": "DEVICE_SN",  
     "device_mac": "DEVICE_MAC",  
     "device_cloud_id": "DEVICE_CLOUD_ID",  
     "device_name": "DEVICE_NAME",  
     "device_model_id": "DEVICE_MODEL_ID",  
     "device_model_name": "DEVICE_MODEL_NAME",  
     "device_firmware_version": "DEVICE_FIRMWARE_VERSION"  
     "license_product_id": "LICENSE_PRODUCT_ID",  
     "license_product_name": "LICENSE_PRODUCT_NAME",  
     "license_state": "LICENSE_STATE",  
     "license_expires_at": "LICENSE_EXPIRES_AT"  
   }

2.8. Opened Ticket - When tickets are opened by end users.
The following data will be sent:

{
  "event_type": "ticket_opened",
  "ticket_id": "TICKET_ID",
  "organization_display_name": "ORGANIZATION_DISPLAY_NAME",
  "partner_display_name": "PARTNER_DISPLAY_NAME",
  "user_email": "USER_EMAIL",
  "user_name": "USER_NAME",
  "user_id": "USER_ID",
  "status": "STATUS",
  "title": "TITLE",
  "description": "DESCRIPTION",
  "device_id": "DEVICE_ID",
  "device_name": "DEVICE_NAME",
  "device_model_name": "DEVICE_MODEL_NAME",
  "device_sub_model": "DEVICE_SUB_MODEL",
  "device_created_at": "DEVICE_CREATED_AT"
}

2.9. Updated Ticket - When tickets are updated by end users.
The following data will be sent:

{
  "event_type": "ticket_updated",
  "ticket_id": "TICKET_ID",
  "organization_display_name": "ORGANIZATION_DISPLAY_NAME",
  "partner_display_name": "PARTNER_DISPLAY_NAME",
  "user_email": "USER_EMAIL",
  "user_name": "USER_NAME",
  "user_id": "USER_ID",
  "status": "STATUS",
  "title": "TITLE",
  "description": "DESCRIPTION",
  "device_id": "DEVICE_ID",
  "device_name": "DEVICE_NAME",
  "device_model_name": "DEVICE_MODEL_NAME",
  "device_sub_model": "DEVICE_SUB_MODEL",
  "device_created_at": "DEVICE_CREATED_AT"
}

2.10. Closed Ticket - When tickets are closed by end users.
The following data will be sent:

{
  "event_type": "ticket_closed",
  "ticket_id": "TICKET_ID"
}