Event ID | Payload Sample |
---|
Clients Management |
---|
clients.create
The client has been created | {
"event" : {
"dt" : "2000-01-01T00:00:00+00:00" ,
"events_id" : "clients.create" ,
"object_id" : 12
},
"data" : {
"id" : 12 ,
"name" : "My name",
"companies_id" : 3 , ...
}
}
|
clients.update
The client's details have been updated | {
"event" : {
"dt" : "2000-01-01T00:00:00+00:00" ,
"events_id" : "clients.update" ,
"object_id" : 12
},
"data" : {
"id" : 12 ,
"name" : "My changed name"
}
}
|
clients.archive
The client has been archived | {
"event" : {
"dt" : "2000-01-01T00:00:00+00:00" ,
"events_id" : "clients.archive" ,
"object_id" : 12
},
"data" : {}
}
|
clients.delete
The client has been completely deleted Not to be confused with archived | {
"event" : {
"dt" : "2000-01-01T00:00:00+00:00" ,
"events_id" : "clients.delete" ,
"object_id" : 12
},
"data" : {}
}
|
clients.balance_zero
The client's balance became <=0
| {
"event" : {
"dt" : "2000-01-01T00:00:00+00:00" ,
"events_id" : "clients.balance_zero" ,
"object_id" : 12
},
"data" : {}
}
|
clients.balance_notzero
The client's balance became > 0
| {
"event" : {
"dt" : "2000-01-01T00:00:00+00:00" ,
"events_id" : "clients.balance_notzero" ,
"object_id" : 12
},
"data" : {}
}
|
clients.custom_fields.update
The client's Custom Field has been updated | {
"event" : {
"dt" : "2000-01-01T00:00:00+00:00" ,
"events_id" : "clients.custom_fields.update" ,
"object_id" : 12
},
"data" : {
"id" : 12 ,
"custom-field-name" : "custom-field-value"
}
}
|
Accounts Management |
---|
clients.accounts.create
The account has been created | {
"event" : {
"dt" : "2000-01-01T00:00:00+00:00" ,
"events_id" : "clients.accounts.create" ,
"object_id" : 12
},
"data" : {
"id" : 12 ,
"clients_id" : 7 ,
"name" : "My account" ,
"auth_type" : "name" ,
...
}
}
|
clients.accounts.update
The account's details have been updated | {
"event" : {
"dt" : "2000-01-01T00:00:00+00:00" ,
"events_id" : "clients.accounts.update" ,
"object_id" : 12
},
"data" : {
"id" : 12 ,
"name" : "My changed account"
}
}
|
clients.accounts.delete
The account has been completely deleted | {
"event" : {
"dt" : "2000-01-01T00:00:00+00:00" ,
"events_id" : "clients.accounts.delete" ,
"object_id" : 12
},
"data" : {}
}
|
Subscriptions Management |
---|
clients.subscriptions.assign
The subscription has been assigned | {
"event" : {
"dt" : "2000-01-01T00:00:00+00:00" ,
"events_id" : "clients.subscriptions.assign" ,
"object_id" : 12
},
"data" : {
"id" : 12 ,
"clients_id" : 34 ,
"packages_id" : 56 ,
"stop_dt" : "2023-01-01T00:00:00+00:00" ,
...
}
}
|
clients.subscriptions.activate
The subscription has been activated | {
"event" : {
"dt" : "2000-01-01T00:00:00+00:00" ,
"events_id" : "clients.subscriptions.activate" ,
"object_id" : 12
},
"data" : {
"id" : 12 ,
"clients_id" : 34 ,
"packages_id" : 56 ,
"stop_dt" : "2023-01-01T00:00:00+00:00" ,
"condition" : "activated" ,
...
}
}
|
clients.subscriptions.deactivate
The subscription has been deactivated | {
"event" : {
"dt" : "2000-01-01T00:00:00+00:00" ,
"events_id" : "clients.subscriptions.deactivate" ,
"object_id" : 12
},
"data" : {
"id" : 12 ,
"clients_id" : 34 ,
"packages_id" : 56 ,
"stop_dt" : "2023-01-01T00:00:00+00:00" ,
"condition" : "deactivated" ,
...
}
}
|
clients.subscriptions.renew
The subscription has been renewed | {
"event" : {
"dt" : "2000-01-01T00:00:00+00:00" ,
"events_id" : "clients.subscriptions.renew" ,
"object_id" : 12
},
"data" : {
"id" : 12 ,
"clients_id" : 34 ,
"packages_id" : 56 ,
"stop_dt" : "2023-01-01T00:00:00+00:00" ,
"renew_count" : 1 ,
...
}
}
|
clients.subscriptions.close
The subscription has been closed | {
"event" : {
"dt" : "2000-01-01T00:00:00+00:00" ,
"events_id" : "clients.subscriptions.close" ,
"object_id" : 12
},
"data" : {
"id" : 12 ,
"clients_id" : 34 ,
"packages_id" : 56 ,
"stop_dt" : "2000-01-01T00:00:00+00:00" ,
...
}
}
|
Email Rates Manager |
---|
email_rates_manager.import
The |