Events list
List of events
This section contains all defined events with their publishing services and data sent for each.
customer.created
Publishers: platform, license-api
Data: customer
customer.deleted
Publishers: platform
Data: customer
customer.updated
Publishers: platform, license-api
Data: customer
device_variable.created
Publishers: platform, license-api
Data: device_variable
device_variable.deleted
Publishers: platform, license-api
Data: device_variable
device_variable.updated
Publishers: platform, license-api
Data: device_variable
installation_file.created
Publishers: platform
Data: installation_file
installation_file.deleted
Publishers: platform
Data: installation_file
installation_file.updated
Publishers: platform
Data: installation_file
license.activated
Publishers: license-api
Data: license, device, license_user (optional)
license.checked
Publishers: license-api
Data: license, device, license_user (optional)
license.created
Publishers: license-api
Data: license
license.deactivated
Publishers: license-api
Data: license, device, license_user (optional)
license.deleted
Publishers: platform
Data: license
license.expired
Publishers: platform
Data: license
license.license_user.assigned
Publishers: user-portal
Data: license, license_user
license.license_user.unassigned
Publishers: user-portal
Data: license, license_user
license.maintenance_expired
Publishers: platform
Data: license
license.maintenance_will_expire_3_days
Publishers: platform
Data: license
license.released
Publishers: license-api
Data: license, device, license_user (optional)
license.reset
Publishers: platform, user-portal
Data: license
license.updated
Publishers: platform
Data: license
license.will_expire_3_days
Publishers: platform
Data: license
license_custom_field.created
Publishers: platform
Data: license_custom_field
license_custom_field.deleted
Publishers: platform
Data: license_custom_field
license_custom_field.updated
Publishers: platform
Data: license_custom_field
license_product_feature.created
Publishers: platform
Data: license_product_feature
license_product_feature.deleted
Publishers: platform
Data: license_product_feature
license_product_feature.updated
Publishers: platform
Data: license_product_feature
license_user_group.created
Publishers: platform
Data: license_user_group
license_user_group.deleted
Publishers: platform
Data: license_user_group
license_user_group.license_user.manager_assigned
Publishers: platform, user-portal
Data: license_user_group, license_user
license_user_group.updated
Publishers: platform
Data: license_user_group
order.created
Publishers: license-api
Data: order
order.deleted
Publishers: platform
Data: order
order.license_user.manager_assigned
Publishers: user-portal
Data: order, license_user
order.license_user.manager_removed
Publishers: user-portal
Data: order, license_user
order.updated
Publishers: platform
Data: order
product.created
Publishers: platform
Data: product
product.deleted
Publishers: platform
Data: product
product.updated
Publishers: platform
Data: product
product_custom_field.created
Publishers: platform
Data: product_custom_field
product_custom_field.deleted
Publishers: platform
Data: product_custom_field
product_custom_field.updated
Publishers: platform
Data: product_custom_field
product_feature.created
Publishers: platform
Data: product_feature
product_feature.deleted
Publishers: platform
Data: product_feature
product_feature.updated
Publishers: platform
Data: product_feature
scheduled_update.canceled
Publishers: platform
Data: scheduled_update
scheduled_update.created
Publishers: platform
Data: scheduled_update
scheduled_update.processed
Publishers: platform
Data: scheduled_update
scheduled_update.simulated
Publishers: platform
Data: scheduled_update
scheduled_update.updated
Publishers: platform
Data: scheduled_update
scheduled_update.will_process_1_day
Publishers: platform
Data: scheduled_update, future_scheduled_update
Event data
Data sent with each event if applicable.
id (str) - uuid4 generated unique event id
event (str) - event code
user_id (int) - id of the user who triggered the event
optional
legacy, initiator_id and initiator_type should be used instead
initiator_id (str) - id of action initiator
optional
initiator_type (str) - type of action initiator
optional
possible values:
management_api_key,platform_user,license_user,api_key,oauth_client_id
ts (int) - unix epoch timestamp of the event occurrence
data (Object) - custom data depending on event
Custom data
This section contains object data definitions for objects that are sent with each event. Which objects are sent with which event is defined in the Events section above.
customer (Object)
id (int)
email (str)
first_name (str)
last_name (str)
phone (str)
reference (str)
address (str)
postcode (str)
city (str)
country (str)
state (str)
device (Object)
id (int)
hardware_id (str)
device_variable (Object)
id (int)
device_id (int)
variable (str)
value (str)
installation_file (Object)
id (int)
product_id (int)
version (str)
full_link (str)
filename (str)
release_date (date)
enabled (boolean)
hash_md5 (str)
environment (str)
release_notes_link (str)
eula_link (str)
size (str)
requires_version (str)
channel (str)
license (Object)
id (int)
license_key (str)
max_license_users (int)
is_trial (boolean)
active (boolean)
validity_period (date)
enable_maintenance_period (boolean)
maintenance_period (date)
max_activations (int)
times_activated (int)
enabled (boolean)
total_consumptions (int)
max_consumptions (int)
allow_overages (boolean)
max_overages (int)
activation_type (boolean) - optional
deactivation_type (boolean) - optional
order (Object)
product (Object)
license_custom_field (Object)
id (int)
value (str)
license_id (int)
product_custom_field_id (int)
license_product_feature (Object)
id (int)
license_id (int)
product_feature_id (int)
max_consumption (int)
total_consumptions (int)
expiry_date (date)
allow_overages (boolean)
consumption_period (str)
max_overages (int)
floating_timeout (int)
floating_users (int)
is_floating (boolean)
is_floating_cloud (boolean)
allow_negative_consumptions (boolean)
license_user (Object)
id (int)
true_email (str)
first_name (str)
last_name (str)
license_user_group (Object)
id (int)
code (str)
name (str)
order (Object)
id (int)
store_id (str)
product (Object)
id (int)
product_name (str)
short_code (str)
active (boolean)
authorization_method (str)
is_archived (boolean)
is_bundle (boolean)
product_custom_field (Object)
id (int)
name (str)
default_value (str)
product_feature (Object)
id (int)
product_id (int)
name (str)
code (str)
is_deleted (boolean)
feature_type (str)
max_consumption (int)
allow_unlimited_consumptions (boolean)
allow_negative_consumptions (boolean)
allow_overages (boolean)
max_overages (int)
reset_consumption (boolean)
consumption_period (str)
floating_timeout (int)
floating_users (int)
is_floating (boolean)
is_floating_cloud (boolean)
floating_timeout (int)
floating_users (int)
future_scheduled_update (Object)
status (str)
errors (list[str])
scheduled_update (Object)
id (int)
license (Object)
scheduled_update_data (list[Object])
status (str)
scheduled_at (datetime)
name (str)
note (str)
scheduled_update_data (Object)
id (int)
action (str)
product_feature (Object) - optional
product_custom_field (Object) - optional
update_data (Object)
error_message (str)
Last updated
Was this helpful?