> For the complete documentation index, see [llms.txt](https://docs.licensespring.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.licensespring.com/events-api/event-list.md).

# Event List

LicenseSpring sends an event to your webhook endpoints when something changes in your account: a device activates a license, a license expires, an order is created, a product is archived. This page lists every event you can subscribe to. Each group of events links to a page that says exactly when each event is sent, when it is not, and what it carries.

{% hint style="info" %}
Webhooks are an Enterprise feature. Set up endpoints in the vendor platform under **Settings > Webhooks**. See Webhooks for setup and signature checks.
{% endhint %}

### Subscribing to events

{% stepper %}
{% step %}

#### Open Settings > Webhooks

Add an endpoint, or edit an existing one.
{% endstep %}

{% step %}

#### Select the events your integration needs

Select them under **Events**. Pick only the ones you use: every event you select is sent to the endpoint.

<figure><img src="https://1783554078-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgLzurdfXUuKr9IziZWLz%2Fuploads%2FStuA64m9v0RhD1G5ZZC4%2F01-add-endpoint-consumption-events.jpg?alt=media&amp;token=c91d1b9b-1a30-49a4-87b6-19256224e011" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

#### Confirm

The endpoint's **Events** tab lists what it is subscribed to.
{% endstep %}
{% endstepper %}

### All events

| Group                | Event                                                   | Sent when                                                                                          |
| -------------------- | ------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
| License              | `license.created`                                       | A license is issued in a new order, an order you add licenses to, or a trial.                      |
| License              | `license.activated`                                     | A device activates the license.                                                                    |
| License              | `license.checked`                                       | A device checks the license.                                                                       |
| License              | `license.deactivated`                                   | A device deactivates the license.                                                                  |
| License              | `license.released`                                      | A device releases a floating license.                                                              |
| License              | `license.updated`                                       | The license is edited, enabled or disabled, its consumptions are reset, or it records consumption. |
| License              | `license.reset`                                         | The license is reset.                                                                              |
| License              | `license.deleted`                                       | The license is deleted.                                                                            |
| License              | `license.will_expire_3_days`                            | The license expires in 3 days.                                                                     |
| License              | `license.expired`                                       | The license expires today.                                                                         |
| License              | `license.maintenance_will_expire_3_days`                | Maintenance ends in 3 days.                                                                        |
| License              | `license.maintenance_expired`                           | Maintenance ends today.                                                                            |
| License              | `license.license_user.assigned`                         | A license user is assigned to the license.                                                         |
| License              | `license.license_user.unassigned`                       | A license user is removed from the license.                                                        |
| License              | `license.consumption_added`                             | The license records consumption.                                                                   |
| License              | `license.consumption_max_reached`                       | The license reaches its consumption limit.                                                         |
| License feature      | `license_product_feature.created`                       | A feature is added to a license.                                                                   |
| License feature      | `license_product_feature.updated`                       | A feature on a license changes.                                                                    |
| License feature      | `license_product_feature.deleted`                       | A feature is removed from a license.                                                               |
| License feature      | `license_product_feature.consumption_added`             | A feature records consumption.                                                                     |
| License feature      | `license_product_feature.consumption_max_reached`       | A feature reaches its consumption limit.                                                           |
| License custom field | `license_custom_field.created`                          | A custom field value is set on a license.                                                          |
| License custom field | `license_custom_field.updated`                          | A license's custom field value changes.                                                            |
| License custom field | `license_custom_field.deleted`                          | A custom field value is removed from a license.                                                    |
| Device variable      | `device_variable.created`                               | A device sends a new variable, or one is added in the platform.                                    |
| Device variable      | `device_variable.updated`                               | A device variable's value changes.                                                                 |
| Device variable      | `device_variable.deleted`                               | A device variable is deleted in the platform.                                                      |
| Consumption pool     | `consumption_pool.consumption_added`                    | A license or feature in a pool records consumption.                                                |
| Consumption pool     | `consumption_pool.consumption_max_reached`              | A pool reaches its limit.                                                                          |
| Consumption pool     | `consumption_pool.reset`                                | A pool is reset manually.                                                                          |
| Offline checkout     | `consumption_pool_license_checkout.checked_out`         | An offline device reserves units from a license pool.                                              |
| Offline checkout     | `consumption_pool_license_checkout.synced`              | An offline device's license pool reservation is settled.                                           |
| Offline checkout     | `consumption_pool_license_feature_checkout.checked_out` | An offline device reserves units from a feature pool.                                              |
| Offline checkout     | `consumption_pool_license_feature_checkout.synced`      | An offline device's feature pool reservation is settled.                                           |
| Customer             | `customer.created`                                      | A customer is created.                                                                             |
| Customer             | `customer.updated`                                      | A customer's details change.                                                                       |
| Customer             | `customer.deleted`                                      | A customer is deleted.                                                                             |
| Order                | `order.created`                                         | A new order is created.                                                                            |
| Order                | `order.updated`                                         | An order is edited.                                                                                |
| Order                | `order.deleted`                                         | An order is deleted.                                                                               |
| Order                | `order.license_user.manager_assigned`                   | A license user becomes a manager of the order.                                                     |
| Order                | `order.license_user.manager_removed`                    | A license user stops being a manager of the order.                                                 |
| License user group   | `license_user_group.created`                            | A license user group is created.                                                                   |
| License user group   | `license_user_group.updated`                            | A license user group is edited.                                                                    |
| License user group   | `license_user_group.deleted`                            | A license user group is deleted.                                                                   |
| License user group   | `license_user_group.license_user.manager_assigned`      | A license user becomes a manager of the group.                                                     |
| Product              | `product.created`                                       | A product is created.                                                                              |
| Product              | `product.updated`                                       | A product is edited, enabled, disabled, archived or restored.                                      |
| Product feature      | `product_feature.created`                               | A feature is created on a product.                                                                 |
| Product feature      | `product_feature.updated`                               | A product feature is edited.                                                                       |
| Product feature      | `product_feature.deleted`                               | A product feature is deleted.                                                                      |
| Product custom field | `product_custom_field.created`                          | A custom field is created on a product.                                                            |
| Product custom field | `product_custom_field.updated`                          | A product custom field is edited.                                                                  |
| Product custom field | `product_custom_field.deleted`                          | A product custom field is deleted.                                                                 |
| Installation file    | `installation_file.created`                             | An installation file is added to a product.                                                        |
| Installation file    | `installation_file.updated`                             | An installation file is edited.                                                                    |
| Installation file    | `installation_file.deleted`                             | An installation file is deleted.                                                                   |
| Scheduled update     | `scheduled_update.created`                              | A scheduled update is created.                                                                     |
| Scheduled update     | `scheduled_update.updated`                              | A scheduled update is edited.                                                                      |
| Scheduled update     | `scheduled_update.canceled`                             | A scheduled update is canceled.                                                                    |
| Scheduled update     | `scheduled_update.simulated`                            | A scheduled update is previewed without being applied.                                             |
| Scheduled update     | `scheduled_update.will_process_1_day`                   | A scheduled update is due within 24 hours.                                                         |
| Scheduled update     | `scheduled_update.processed`                            | A scheduled update was applied, or failed.                                                         |

#### Details for each group

* [License events](https://docs.licensespring.com/events-api/events-list/license-events)
* [License feature events](https://docs.licensespring.com/events-api/events-list/license-feature-events)
* [License custom field and device variable events](https://docs.licensespring.com/events-api/events-list/custom-field-and-device-variable-events)
* [Consumption pool and offline checkout events](https://docs.licensespring.com/events-api/events-list/consumption-events), including the license and feature consumption events
* [Customer, order and license user group events](https://docs.licensespring.com/events-api/events-list/customer-and-order-events)
* [Product events](https://docs.licensespring.com/events-api/events-list/product-events), including product features, product custom fields and installation files
* [Scheduled update events](https://docs.licensespring.com/events-api/events-list/scheduled-update-events)

### What every event looks like

Every event is a JSON `POST` to your endpoint with this body:

| Field            | Type            | Description                                                                                                                                                                                    |
| ---------------- | --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id`             | string          | Unique event id (UUID). Use it to skip events you have already processed.                                                                                                                      |
| `event`          | string          | The event code, for example `license.activated`.                                                                                                                                               |
| `ts`             | integer         | When LicenseSpring sent the event, as a Unix timestamp in seconds.                                                                                                                             |
| `initiator_type` | string or null  | Who caused the event: `platform_user`, `management_api_key`, `license_user`, `api_key` or `oauth_client_id`. `null` for events LicenseSpring sends on its own schedule, such as expiry events. |
| `initiator_id`   | string or null  | The id of the initiator: the platform user's id, the first characters of the API key, or the OAuth client id.                                                                                  |
| `user_id`        | integer or null | Legacy. Use `initiator_id` and `initiator_type` instead.                                                                                                                                       |
| `data`           | object          | The objects the event is about. The event pages list them, and [Event data objects](https://docs.licensespring.com/events-api/events-list/event-data-objects) defines their fields.            |

Example payload for a deleted license:

```json
{
  "id": "2b6f0c1e-4d8a-4f3b-9c2e-7a1d5e8b9f04",
  "event": "license.deleted",
  "user_id": 312,
  "initiator_id": "312",
  "initiator_type": "platform_user",
  "ts": 1792656041,
  "data": {
    "license": {
      "id": 1790242270029099,
      "license_key": "DEMO-AAAA-BBBB-CCCC",
      "...": "see Event data objects"
    }
  }
}
```

### Rules that apply to every event

* **Events are sent only after a change is saved.** A request that fails sends nothing.
* **Created, updated and reset events carry the state after the change.** Deleted events carry the state just before the deletion.
* **Bulk actions send one event per item.** For example, disabling 20 licenses at once sends 20 `license.updated` events. For a bundle, actions on the bundle license also send one event for each license in the bundle, unless the event page says otherwise.
* **Imports and side effects send nothing.** CSV imports, and objects that are deleted or changed as a side effect of another action (for example the licenses of a deleted order), send no events of their own. Each event page lists the cases that matter.
* **Events are not ordered.** Two events from the same action can arrive in either order. Use `ts` and the data, not arrival order.
* **Each event is sent once.** A delivery that fails is not retried automatically. You can resend it from the endpoint's History. See [Webhooks](https://docs.licensespring.com/events-api/webhooks).
* **The same change can arrive twice** in rare cases. Make your handler skip an `id` it has already processed.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.licensespring.com/events-api/event-list.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
