An event is generated and transmitted to a configured server for provisioning purposes when any of the following has occurred:
- A new subscription has been created
- An existing subscription has been updated
- The status of an existing subscription has changed
- A new customer has been created
- An existing customer has been updated
- The status of an existing customer has changed
- A Ping event has been manually triggered
NOTE: To receive provisioning events, a provisioning server endpoint or e-mail address must have been configured.
Events
The following subscription related events are available:
The following customer related events are available:
NOTE: Customer level events are disabled by default. They can be enabled on the provisioning configuration page.
The following miscellaneous event is also available:
Data Structures
Provision
| Field | Description | Required | Format |
|---|---|---|---|
| Version | Provisioning API version string. | yes | up to 20 characters |
| Events | Array of one or more events that have occurred. | yes | Array of Event |
Event
| Field / Attribute | Description | Required | Format |
|---|---|---|---|
| EventName | The name of the event. One of the following: "SubscriptionCreatedEvent", "SubscriptionUpdatedEvent", "SubscriptionStatusUpdatedEvent" | yes | up to 60 characters |
| EventId | Unique identifier for the event. | yes | up to 60 characters |
| Customer | Customer information. | supplied for "SubscriptionCreatedEvent" | Customer structure |
| CustomerID | Numeric identifier for the customer. |
supplied for "SubscriptionUpdatedEvent" |
numeric |
| Subscription | Subscription information. | supplied for "SubscriptionCreatedEvent", "SubscriptionUpdatedEvent" | Subscription structure |
| SubscriptionID | Numeric identifier for the subscription. | supplied for "SubscriptionStatusUpdatedEvent" | numeric |
| Status | The subscription status. | supplied for "SubscriptionStatusUpdatedEvent" | enumeration. one of "Active", "Suspended", "Closed","Inactive" |