Client Events (Whitelabel)
A comprehensive list of events that can activate webhooks for client changes, including creation, updates, and deletions.
Events
| Event | Description |
|---|---|
client-created | Triggers whenever a new client is created. |
client-updated | Triggers whenever a client is updated. |
client-removed | Triggers whenever a client is deleted. |
Webhook Payload Examples
client-created
{
"event_id": "whev_vgq98p47zudgeedxx",
"event_type": "client-created",
"api_version": 2,
"object": "event",
"data": {
"client": {
"id": "daa06218-1007-4c79-88e6-1eed7a86c53c",
"email": "[email protected]",
"locale": "en",
"type": "client",
"registration_date": 1671144713,
"address": null,
"telephone": null,
"customer_id": null,
"city": null,
"postcode": null,
"state": null,
"country": "de",
"vat": null,
"business_information": {
"name": "Mike Doe",
"country": "de",
"email": "[email protected]",
"currencies": [
"EUR"
],
"default_currency": "EUR",
"languages": [
"en"
],
"logos": {},
"facebook": null,
"instagram": null,
"twitter": null,
"pinterest": null,
"offset": "+00:00"
},
"currency": "EUR",
"payments": [
"cash"
],
"name": "Mike Doe",
"stock_tracking": true,
"whitelist": null,
"rounding": {
"method": "default",
"precision": 0.01
},
"untracked_ips": null,
"indexing": true,
"invoice_settings": {
"invoice_prefix": "MIK",
"next_invoice_number": 1,
"invoice_language": "de",
"invoices_enabled": true,
"invoice_template": "default"
},
"datev": null,
"is_verified": false,
"billing_plan": null,
"permissions": {
"account": {
"view": true,
"edit": true,
"remove": true
},
"billing": {
"view": true,
"edit": true
},
"keys": {
"view": true,
"edit": true,
"remove": true,
"create": true
},
"webhooks": {
"view": true,
"edit": true,
"remove": true,
"create": true
},
"logs": {
"view": true
},
"audit_trail": {
"view": true
},
"revenue_analytics": {
"view": true
},
"source_analytics": {
"view": true
},
"visitor_analytics": {
"view": true
},
"domains": {
"edit": true,
"view": true,
"create": true,
"remove": true
},
"taxes": {
"edit": true,
"view": true,
"create": true,
"remove": true
},
"teammates": {
"edit": true,
"view": true,
"create": true,
"remove": true
},
"reports": {
"view": true,
"edit": true
},
"sites": {
"edit": true,
"view": true,
"create": true,
"remove": true,
"publish": true
},
"pages": {
"edit": true,
"view": true,
"create": true,
"remove": true
},
"affiliate_programs": {
"edit": true,
"view": true,
"create": true,
"remove": true
},
"affiliates": {
"edit": true,
"view": true,
"remove": true
},
"payouts": {
"edit": true,
"view": true,
"create": true,
"remove": true
},
"affiliate_network": {
"edit": true,
"view": true
},
"payments": {
"edit": true,
"view": true,
"remove": true
},
"integrations": {
"edit": true,
"create": true,
"publish": true,
"view": true,
"remove": true
},
"invoices": {
"view": true,
"edit": true,
"remove": true,
"create": true
},
"subscriptions": {
"view": true,
"edit": true,
"remove": true
},
"instalment_plans": {
"view": true,
"edit": true,
"remove": true
},
"customers": {
"view": true,
"edit": true,
"create": true,
"remove": true
},
"subscribers": {
"view": true,
"edit": true,
"create": true,
"remove": true
},
"mailing_lists": {
"view": true,
"edit": true,
"create": true,
"remove": true
},
"automations": {
"view": true,
"edit": true,
"create": true,
"remove": true
},
"discounts": {
"view": true,
"edit": true,
"create": true,
"remove": true
},
"email_templates": {
"view": true,
"edit": true,
"create": true,
"remove": true
},
"reviews": {
"view": true,
"edit": true,
"remove": true
},
"assets": {
"view": true,
"edit": true,
"create": true,
"remove": true
},
"products": {
"view": true,
"edit": true,
"create": true,
"remove": true
},
"shippings": {
"view": true,
"edit": true,
"create": true,
"remove": true
},
"warehouses": {
"view": true,
"edit": true,
"create": true,
"remove": true
},
"support": {
"view": true,
"edit": true,
"create": true,
"remove": true
}
},
"status": "trialing",
"quotas": {
"used_storage_quota": 0,
"storage_quota": 0,
"datatransfer_quota": 0,
"used_datatransfer": 0,
"automations_quota": 100,
"used_automations": 0,
"transaction_quota": 0,
"used_transactions": 0,
"products_quota": 0,
"used_products": 0,
"languages_quota": 1,
"used_languages": 1,
"domains_quota": 0,
"currencies_quota": 1,
"used_currencies": 1,
"used_domains": 0,
"teammates_quota": 0,
"used_teammates": 0,
"api_quota": 0,
"used_api": 0,
"newsletters_quota": 0,
"used_newsletters": 0
}
}
},
"endpoint_id": "5dcbcd22-c0e5-4003-8223-e367ce5eb8bf"
}client-updated
{
"event_id": "whev_6179pqxr6bk7jjmok",
"event_type": "client-updated",
"api_version": 2,
"object": "event",
"data": {
"client": {
"id": "5b08f9ef-d44e-4320-b52a-84ed71627a53",
"email": "[email protected]",
"locale": "en",
"type": "client",
"registration_date": 1671145743,
"address": null,
"telephone": null,
"customer_id": null,
"city": null,
"postcode": null,
"state": null,
"country": "de",
"vat": null,
"business_information": {
"name": "Mike Doe",
"country": "de",
"email": "[email protected]",
"currencies": [
"EUR"
],
"default_currency": "EUR",
"languages": [
"en"
],
"logos": {},
"facebook": null,
"instagram": null,
"twitter": null,
"pinterest": null,
"offset": "+00:00"
},
"currency": "EUR",
"payments": [
"cash"
],
"name": "Mike Doe",
"stock_tracking": true,
"whitelist": null,
"rounding": {
"method": "default",
"precision": 0.01
},
"untracked_ips": null,
"indexing": true,
"invoice_settings": {
"invoice_prefix": "MIK",
"next_invoice_number": 1,
"invoice_language": "de",
"invoices_enabled": true,
"invoice_template": "default"
},
"datev": null,
"is_verified": false,
"billing_plan": null,
"quotas": {
"used_storage": 0,
"storage_quota": 0,
"datatransfer_quota": 0,
"used_datatransfer": 0,
"automations_quota": 100,
"used_automations": 0,
"transaction_quota": 0,
"used_transactions": 0,
"products_quota": 0,
"used_products": 0,
"languages_quota": 1,
"used_languages": 1,
"domains_quota": 0,
"currencies_quota": 1,
"used_currencies": 1,
"used_domains": 0,
"teammates_quota": 0,
"used_teammates": 0,
"api_quota": 0,
"used_api": 0,
"newsletters_quota": 0,
"used_newsletters": 0
},
"permissions": {
"account": {
"view": true,
"edit": true,
"remove": true
},
"billing": {
"view": true,
"edit": true
},
"keys": {
"view": true,
"edit": true,
"remove": true,
"create": true
},
"webhooks": {
"view": true,
"edit": true,
"remove": true,
"create": true
},
"logs": {
"view": true
},
"audit_trail": {
"view": true
},
"revenue_analytics": {
"view": true
},
"source_analytics": {
"view": true
},
"visitor_analytics": {
"view": true
},
"domains": {
"edit": true,
"view": true,
"create": true,
"remove": true
},
"taxes": {
"edit": true,
"view": true,
"create": true,
"remove": true
},
"teammates": {
"edit": true,
"view": true,
"create": true,
"remove": true
},
"reports": {
"view": true,
"edit": true
},
"sites": {
"edit": true,
"view": true,
"create": true,
"remove": true,
"publish": true
},
"pages": {
"edit": true,
"view": true,
"create": true,
"remove": true
},
"affiliate_programs": {
"edit": true,
"view": true,
"create": true,
"remove": true
},
"affiliates": {
"edit": true,
"view": true,
"remove": true
},
"payouts": {
"edit": true,
"view": true,
"create": true,
"remove": true
},
"affiliate_network": {
"edit": true,
"view": true
},
"payments": {
"edit": true,
"view": true,
"remove": true
},
"integrations": {
"edit": true,
"create": true,
"publish": true,
"view": true,
"remove": true
},
"invoices": {
"view": true,
"edit": true,
"remove": true,
"create": true
},
"subscriptions": {
"view": true,
"edit": true,
"remove": true
},
"instalment_plans": {
"view": true,
"edit": true,
"remove": true
},
"customers": {
"view": true,
"edit": true,
"create": true,
"remove": true
},
"subscribers": {
"view": true,
"edit": true,
"create": true,
"remove": true
},
"mailing_lists": {
"view": true,
"edit": true,
"create": true,
"remove": true
},
"automations": {
"view": true,
"edit": true,
"create": true,
"remove": true
},
"discounts": {
"view": true,
"edit": true,
"create": true,
"remove": true
},
"email_templates": {
"view": true,
"edit": true,
"create": true,
"remove": true
},
"reviews": {
"view": true,
"edit": true,
"remove": true
},
"assets": {
"view": true,
"edit": true,
"create": true,
"remove": true
},
"products": {
"view": true,
"edit": true,
"create": true,
"remove": true
},
"shippings": {
"view": true,
"edit": true,
"create": true,
"remove": true
},
"warehouses": {
"view": true,
"edit": true,
"create": true,
"remove": true
},
"support": {
"view": true,
"edit": true,
"create": true,
"remove": true
}
},
"status": "trialing"
},
"changes": [
"quotas",
"permissions"
]
},
"endpoint_id": "5dcbcd22-c0e5-4003-8223-e367ce5eb8bf"
}client-removed
{
"event_id": "whev_oe6jmm91fv64v755",
"event_type": "client-removed",
"api_version": 2,
"object": "event",
"data": {
"client": {
"id": "a9dc21e9-ce2c-497c-b295-1d2c0de31563"
}
},
"endpoint_id": "5dcbcd22-c0e5-4003-8223-e367ce5eb8bf"
}