{
"id": "123e4567-e89b-12d3-a456-426614174000",
"subscription_id": "123e4567-e89b-12d3-a456-426614174000",
"organization_id": "123e4567-e89b-12d3-a456-426614174000",
"membership_id": "123e4567-e89b-12d3-a456-426614174000",
"type": "v1/clients",
"created_at": "2025-01-27T22:05:07.000Z",
"data": {
"event": "created",
"id": "ce91bc4e-68d6-4ab0-bfab-4a9403f7f316",
"kind": "company",
"type": "company",
"name": "Acme SAS",
"email": "billing@acme.example",
"extra_emails": ["accounting@acme.example"],
"phone": {
"country_code": "+33",
"number": "612345678"
},
"phone_number": "+33612345678",
"tax_identification_number": "FR12345678901",
"vat_number": "FR12345678901",
"locale": "fr",
"currency": "EUR",
"address": "10 Rue de Rivoli",
"city": "Paris",
"zip_code": "75001",
"country_code": "FR",
"billing_address": {
"street_address": "10 Rue de Rivoli",
"zip_code": "75001",
"city": "Paris",
"country_code": "FR"
},
"created_at": "2025-01-24T10:54:00Z",
"updated_at": "2025-01-24T10:55:00Z"
}
}
Supported webhooks
v1/clients
OAuth scope: organization.read
Webhook that delivers events related to clients.
Supported events:
createdupdateddeleted
WEBHOOK
v1
/
clients
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"subscription_id": "123e4567-e89b-12d3-a456-426614174000",
"organization_id": "123e4567-e89b-12d3-a456-426614174000",
"membership_id": "123e4567-e89b-12d3-a456-426614174000",
"type": "v1/clients",
"created_at": "2025-01-27T22:05:07.000Z",
"data": {
"event": "created",
"id": "ce91bc4e-68d6-4ab0-bfab-4a9403f7f316",
"kind": "company",
"type": "company",
"name": "Acme SAS",
"email": "billing@acme.example",
"extra_emails": ["accounting@acme.example"],
"phone": {
"country_code": "+33",
"number": "612345678"
},
"phone_number": "+33612345678",
"tax_identification_number": "FR12345678901",
"vat_number": "FR12345678901",
"locale": "fr",
"currency": "EUR",
"address": "10 Rue de Rivoli",
"city": "Paris",
"zip_code": "75001",
"country_code": "FR",
"billing_address": {
"street_address": "10 Rue de Rivoli",
"zip_code": "75001",
"city": "Paris",
"country_code": "FR"
},
"created_at": "2025-01-24T10:54:00Z",
"updated_at": "2025-01-24T10:55:00Z"
}
}
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"subscription_id": "123e4567-e89b-12d3-a456-426614174000",
"organization_id": "123e4567-e89b-12d3-a456-426614174000",
"membership_id": "123e4567-e89b-12d3-a456-426614174000",
"type": "v1/clients",
"created_at": "2025-01-27T22:05:07.000Z",
"data": {
"event": "created",
"id": "ce91bc4e-68d6-4ab0-bfab-4a9403f7f316",
"kind": "company",
"type": "company",
"name": "Acme SAS",
"email": "billing@acme.example",
"extra_emails": ["accounting@acme.example"],
"phone": {
"country_code": "+33",
"number": "612345678"
},
"phone_number": "+33612345678",
"tax_identification_number": "FR12345678901",
"vat_number": "FR12345678901",
"locale": "fr",
"currency": "EUR",
"address": "10 Rue de Rivoli",
"city": "Paris",
"zip_code": "75001",
"country_code": "FR",
"billing_address": {
"street_address": "10 Rue de Rivoli",
"zip_code": "75001",
"city": "Paris",
"country_code": "FR"
},
"created_at": "2025-01-24T10:54:00Z",
"updated_at": "2025-01-24T10:55:00Z"
}
}
Authorizations
The signature header follows the format t={timestamp},v1={signature}.
Verification steps:
- Extract the timestamp and signature from the signature header
- Reject the request if the timestamp is older than 5 minutes
- Recreate the signed payload: '{timestamp}.{raw_request_body}'
- Compute HMAC-SHA256 of the signed payload using your webhook secret as the key
- Compare the computed signature with the one in the header
Body
application/json
Webhook payload for topic v1/clients. Delivered whenever a client is created, updated, or deleted.
Unique identifier for this webhook event
Example:
"123e4567-e89b-12d3-a456-426614174000"
ID of the webhook subscription that received the event
Example:
"123e4567-e89b-12d3-a456-426614174000"
ID of the organization that owns the client
Example:
"123e4567-e89b-12d3-a456-426614174000"
ID of the membership associated with the subscription
Example:
"123e4567-e89b-12d3-a456-426614174000"
Webhook topic
Available options:
v1/clients Example:
"v1/clients"
Timestamp when the webhook event was created (RFC3339)
Example:
"2025-01-27T22:05:07.000Z"
Show child attributes
Show child attributes
Response
200
Webhook received successfully
Was this page helpful?