Skip to content
/
Client Event

Client Event
Webhook

Request

Sent when a client is created, updated, or deleted. The data field contains the full client profile with all default includes.

Bodyapplication/jsonrequired
company_idintegerrequired

Location ID where the event occurred.

resourcestringrequired

Resource type.

Value:"client"
resource_idintegerrequired

ID of the resource that was created, updated, or deleted.

statusstringrequired

Type of change that occurred.

Enum:"create""update""delete"
dataobject(Webhook Client Data)required

Client data sent in webhook notifications. Uses the full client profile with all default includes (email, card, birth_date, comment, discount, visits, sex, sms preferences, money, importance, categories, custom_fields, national_id).

Payload
{
  "company_id": 123456,
  "resource": "client",
  "resource_id": 401,
  "status": "create",
  "data": {
    "id": 401,
    "name": "Jane",
    "surname": "Doe",
    "display_name": "Jane Doe",
    "phone": "+1234567890",
    "email": "jane@example.com",
    "discount": 10,
    "visits": 5,
    "sex_id": 2,
    "importance_id": 0,
    "national_id": "950315300129"
  }
}

Responses

Your server should return any 2xx status code to acknowledge receipt.