OCS events

Learn about events generated by Transatel's OCS

Introduction

The OCS generates events related to the product lifecycle and their associated resources. Different events are produced depending on the category of the product. These events can then be pushed to your platform by creating webhooks using the Webhooks API. Integrating such events can allow you to trigger automated logic, for example for the sending of end-user notifications.

To discover how to integrate OCS events, please refer to our integration guide.

Events for products

One-off products

Events emitted according to the One-off product lifecycle

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

Add-on products

Events emitted according to the Add-on product lifecycle

Events for resources

Below are available events emitted on a stack of a given resource.

In contrary to the product level resource events (product resource threshold event & product resource exhaustion event) which are emitted relative to the resource instance of a given subscription (product), the below events are emitted considering all instances of a given resource independently of any product.

Resource events

Events for options

Data safeguard

Events emitted according to the data safeguard option lifecycle

Overspend safeguard

Events emitted according to the overspend safeguard option lifecycle

Payment safeguard

Events emitted according to the payment safeguard option lifecycle

Events for credit

Credit events

Product events

Below is the list of all available product events.

Product preload event

This event occurs when a subscription to a product has been preloaded.

Product activation event

This event occurs when a subscription to a product has been activated.

Product scheduled activation failure event

This event occurs when a product scheduled activation failed.

Product renewal event

This event occurs when a subscription to a Recurring product has been renewed. This event is emitted once the renewal is executed. Upon a renewal, a Recurring product starts a new period and its allowances are reset.

Product cancellation event

This event occurs when a subscription to a Recurring product with unlimited number of occurrences has been canceled. Once such a product is canceled, its expiration date will be set to the end of the current period and no more renewals will be executed.

Product expiration event

This event occurs when a subscription to a product has reached its expiration date. Once a subscription expires, the subscriber will no longer have access to the connectivity services linked to this product.

Product termination event

This event occurs when a subscription to a product has been manually terminated before its expiration date. Once a subscription is terminated, the subscriber will no longer have access to the connectivity services linked to this product.

Renewal reminder event

This configurable event serves as a reminder 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 its configuration. This configuration can be done per product and with a configurable delay in days before the actual renewal.

Renewal failed event

This event occurs when a subscription to a recurring product has failed its renewal. Upon this failure the product will be automatically terminated.

Expiration reminder event

This configurable event serves as a reminder 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.

Product 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 its 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)

Product resource exhausted event

This event occurs when a subscription resource has been exhausted.

Resource events

Below is the list of all available resource events.

Resource threshold event

This configurable event informs that a threshold defined on the total of all instances of a given resource has been crossed. 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. Two modes exist to define a threshold:

• Using a constant value (e.g. 200MB)
• Using a percentage of the total of all instances initial allowances (e.g. 80%)

Resource exhausted event

This event occurs when a resource is exhausted on all its instances. By default, exhaustion events are not active. To activate them, please contact your Transatel account manager to request the proper configuration.

Option events

Below is the list of all available option events.

Data safeguard changed event

This event occurs when a data safeguard option has been changed. This occurs when its state has been changed or when its renewal day has been modified.

Data safeguard cutoff threshold event

This event occurs when roaming data usages have reached the cutoff alert threshold of the data safeguard option.

Data safeguard cutoff reached event

This event occurs when roaming data usages have reached the cutoff limit of the data safeguard option.

Overspend safeguard changed event

This event occurs when an overspend safeguard option has been changed. This occurs when its state, its renewal day, its current or next cut-off limits has been changed.

Overspend safeguard first usage event

This event occurs when a first out-of-bundle usage has been made.

Overspend safeguard cutoff threshold event

This event occurs when out-of-bundle usages have reached the cutoff alert threshold of the overspend safeguard option.

Overspend safeguard cutoff reached event

This event occurs when out-of-bundle usages have reached the cutoff limit of the overspend safeguard option.

Payment safeguard changed event

This event occurs when a payment safeguard option has been changed. This occurs when its state has been changed or when its renewal day has been modified.

Payment safeguard cutoff threshold event

This event occurs when premium usages have reached the cutoff alert threshold of the payment safeguard option.

Payment safeguard cutoff reached event

This event occurs when premium usages have reached the cutoff limit of the payment safeguard option.

Credit events

Below is the list of all available credit events.

Credit adjusted event

This event occurs when the amount and/or expiration date of a credit has been adjusted.

Credit withdrawn event

This event occurs when a withdrawal has been performed following a purchase of a product using credits.

Credit threshold event

This configurable event informs that a threshold of a credit has been crossed. By default, threshold events are not active. To activate them, please contact your Transatel account manager to request the configuration of a fixed credit amount threshold.

Credit exhausted event

This event occurs when a credit has been exhausted.