Docs for all releases
Page History
...
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
- Import Manager
- importd.process_success
- importd.process_failed
Event Payload
PayloadStructure
During notification the handler will be called with JSON-formatted data payload. The payload has 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" } } |
The clients.accounts.delete
, clients.archive
, clients.balance_notzero
, clients.balance_zero
, and clients.delete
events send empty data: {} (as we send the event info, there is no need to duplicate it in data).
Info | ||
---|---|---|
| ||
The |
Payload Details
Clients
...
Overview
Content Tools