NOTE: To receive provisioning events, a provisioning endpoint must have been configured.
The following subscription related events are available:
- Subscription Created Event
- Subscription Updated Event
- Subscription Status Changed Event
The following customer related events are available:
- Customer Created Event
- Customer Updated Event
- Customer Status Changed Event
NOTE: Customer level events are disabled by default. They can be enabled on the provisioning configuration page.
The following diagnostic event is also available:
- Ping Event
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” |
Source | The source for the event | one of “ADMIN”, “API”, “CUSTOMERPORTAL”, “PROCESSING”, “RATING” | |
Reason | The reason for the event (when known). | one of “USER”, “TRIALUPGRADE”, “TRIALEXPIRED”, “DUNNING”, “CONVERSION”, “SCHEDULEDCLOSE” |