OCS events
Learn about events generated by Transatel OCS
Introduction
The OCS generates events related to the product lifecycle and their associated resources. Different events are emitted depending on the category of product. Those events can then be pushed to your platform by creating webhooks using the Webhooks API. Integrating those events can allow you to trigger any necessary logic, for example send end-user notifications.
To discover how to integrate OCS events, please refer to our integration guide.
Events on One-off products
Events emitted according to the One-off
product lifecycle
Events on Recurring products
Below are the events emitted according to the Recurring
product lifecycle:
Recurring
with fixed number of occurrences
Recurring
with unlimited number of occurrences
Events on Add-on products
Events emitted according to the Add-on
product lifecycle
Product events
Below is the list of all available product events.
Product preload event
This event informs that a subscription to a product has been preloaded.
Event information: | |
---|---|
Event type definition | OCS/PRODUCT/PRELOADED |
Applicable for | One-off , Recurring |
Product activation event
This event informs that a subscription to a product has been activated.
Event information: | |
---|---|
Event type definition | OCS/PRODUCT/ACTIVATED |
Applicable for | One-off , Recurring , Add-on |
Product renewal event
This event informs that a subscription to a Recurring
product has been renewed.
This event is emitted once the renewal is performed. Upon a renewal, a Recurring
product starts a new period and its allowances are granted again.
Event information: | |
---|---|
Event type definition | OCS/PRODUCT/RENEWED |
Applicable for | Recurring |
Product cancellation event
This event informs that a subscription to a Recurring
product with unlimited number of occurrences has been canceled.
Once such product is canceled, its expiration date will be set to the end of the current period and no more renewals will be performed.
Event information: | |
---|---|
Event type definition | OCS/PRODUCT/CANCELED |
Applicable for | Recurring with unlimited number of occurrences |
Product expiration event
This event informs that a subscription to a product has reached is expiration date. Once a subscription expires, the connectivity services linked to this product stop.
Event information: | |
---|---|
Event type definition | OCS/PRODUCT/EXPIRED |
Applicable for | One-off , Recurring , Add-on |
Product termination event
This event informs that a subscription to a product has been manually terminated before its expiration date. Once a subscription is terminated, the connectivity services linked to this product stop.
Event information: | |
---|---|
Event type definition | OCS/PRODUCT/TERMINATED |
Applicable for | One-off , Recurring , Add-on |
Renewal reminder event
This configurable event reminds that a subscription is about to renew. By default, this reminder is not active. To activate it, please contact your Transatel account manager to request the proper configuration. This configuration can be done per product and with a configurable delay in days before the actual renewal.
Event information: | |
---|---|
Event type definition | OCS/PRODUCT/RENEWAL/REMINDER |
Applicable for | Recurring |
Renewal failed event
This event informs that a subscription to a recurring product has failed its renewal. Upon this failure the product will be automatically terminated.
Event information: | |
---|---|
Event type definition | OCS/PRODUCT/RENEWAL/FAILED |
Applicable for | Recurring |
Expiration reminder event
This configurable event reminds that a subscription is about to expire. By default, this reminder is not active. To activate it, please contact your Transatel account manager to request the proper configuration. This configuration can be done per product and with a configurable delay in days before the actual expiration.
Event information: | |
---|---|
Event type definition | OCS/PRODUCT/EXPIRATION/REMINDER |
Applicable for | One-off , Recurring |
Resource threshold event
This configurable event informs that a subscription resource has crossed a defined threshold. By default, threshold events are not active. To activate them, please contact your Transatel account manager to request the proper configuration. Several thresholds can be configured for the same resource. It exists also two ways to define a threshold:
- by defining a constant value (e.g less than 200MB left)
- by defining a percentage (e.g more than 80% of the allowance used)
Event information: | |
---|---|
Event type definition | OCS/PRODUCT/RESOURCE/THRESHOLD |
Applicable for | One-off , Recurring , Add-on |
Resource exhausted event
This event informs that a subscription resource is exhausted.
Event information: | |
---|---|
Event type definition | OCS/PRODUCT/RESOURCE/EXHAUSTED |
Applicable for | One-off , Recurring , Add-on |