Docs for all releases
Page History
Panel | ||
---|---|---|
| ||
|
The Provisioning API provides a mechanism for real-time integration with 3rd party systems, including softswitches, gateways, and CRM systems. The mechanism calls pre-defined handlers on the occurrence of specific events in the system.
While Core API and Management API sub-systems answer requests, Provisioning API pushes data as soon as an event occurs. For example, you can monitor the client's balance status via this functionality. Thus, when the client's balance is below zero, you can configure the system to send a notification to an external system to avoid any disruptions to your organization's current processes.
Handlers
A typical handler should be configured as is HTTPS or HTTP with an URL of the script, which will get HTTP POST requests about each event occurrence.
Please avoid using the Script type of handlers, they are designed for internal usage within the system.
Panel | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Best practice example There is an example based on https://hostname/handler-endpoint usage. Open the Provisioning section and start creating a handler.
Find an example of the http://handler below:
|
Supported Events
The Provisioning API supports the following list of events:
- Clients
- clients.create
- clients.update
- clients.archive
- clients.delete
- clients.balance_zero
- clients.balance_notzero
- clients.custom_fields.update
- Accounts
- clients.accounts.create
- clients.accounts.update
- clients.accounts.delete
- Subscriptions
- clients.subscriptions.assign
- clients.subscriptions.activate
- clients.subscriptions.deactivate
- clients.subscriptions.renew
- clients.subscriptions.close
- Email Rates Manager
- email_rates_manager.import
- email_rates_manager.rate_tables_no_match
- email_rates_manager.no_attachments
- email_rates_manager.file_processing_error
- Import Manager
- importd.process_success
- importd.process_failed
Info | ||
---|---|---|
| ||
The |
Event Payload
Structure
During notification, the handler will be called with a JSON-formatted data payload. The payload has the following structure:
event
dt
- the date-time of the event in the ISO8601 format;events_id
- ID of the event occurred (helpful, when multiple events are handled by the same handler);object_id
- the entity, to which the event happened;
data
- data related to the specific event.
Example
Code Block |
---|
{ "event": { "dt": "2000-01-01T00:00:00+00:00", "events_id": "clients.update", "object_id": 12 }, "data": { "id": 12, "field": "some-value" } } |
Data
The data provided within the notification depends on the specific type of event.
Events that represent basic status changes will not contain any additional data as the ID of the related entity is provided within the "event" key. Examples of such events are: clients.accounts.delete
, clients.archive
, clients.balance_notzero
, clients.balance_zero, etc.
For the rest of the events, the structure will match the respective CoreAPI method's structure. Please check the respective documentation within the system interface in the Integration/CoreAPI Docs section.
Supported Events
Event ID | Payload Sample |
---|---|
Client details have been updated |
|
Client has been completely deleted Not to be confused with archived |
|
Panel | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
Tip
|