Events API
Events list
4min
This list will be expanded and new events will be added to it. End goal is to cover Create, Update and Delete events for all objects in LicenseSpring, and add some important action events ( eq. license.activated ).
- customer.created
- Data: customer
- customer.deleted
- Data: customer
- customer.updated
- Data: customer
- license.activated
- Data: license
- license.created
- Data: license
- license.deactivated
- Data: license
- license.deleted
- Data: license
- license.expired
- Data: license
- license.license_user.assigned
- Data: license, license_user
- license.maintenance_expired
- Data: license
- license.maintenance_will_expire_3_days
- Data: license
- license.reset
- Data: license
- license.updated
- Data: license
- license.will_expire_3_days
- Data: license
- order.created
- Data: order
- order.deleted
- Data: order
- order.license_user.manager_assigned
- Data: order, license_user
- order.updated
- Data: order
- product.created
- Data: product
- product.updated
- Data: product
Data sent with each event if applicable.
- id (str) - uuid4 generated unique event id
- event (str) - event code
- company_id (int) - id of the company for which the event was triggered
- user_id (int) - id of the user who triggered the event
- ts (int) - unix epoch timestamp of the event occurrence
- data (Object) - custom data depending on event
`user_id` field is optional, and in some cases will be null.
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 List of 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)
- license (Object)
- id (int)
- activations_type ( `online` | `offline` )
- 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)
- order (Object)
- license_user (Object)
- id (int)
- true_email (str)
- first_name (str)
- last_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)

