# Clients

## Client Added

**(i) Payload Format:** Client Added Payload data format and content that Whautomate will transmit to the configured endpoint.

```json
{
  "event": {
    "id": "{{event.id}}",
    "type": "{{event.type}}",
    "timeStamp": "{{event.timeStamp}}",
    "key": "{{event.key}}"
  },
  "client": {
    "id": "{{client.id}}",
    "clientId": "{{client.clientId}}",
    "fullName": "{{client.fullName}}",
    "preferredName": "{{client.preferredName}}",
    "contactType": "{{client.contactType}}",
    "countryCode": "{{client.countryCode}}",
    "phone": "{{client.phone}}",
    "email": "{{client.email}}",
    "registrationDate": "{{client.registrationDate}}",
    "dob": "{{client.dob}}",
    "addressType": "{{client.addressType}}",
    "address": "{{client.address}}",
    "identificationNumber": "{{client.identificationNumber}}",
    "gender": "{{client.gender}}",
    "preferredLanguage": "{{client.preferredLanguage}}",
    "maritalStatus": "{{client.maritalStatus}}",
    "tags": "{{client.tags}}",
    "notes": "{{client.notes}}",
    "referralSource": "{{client.referralSource}}",
    "photo": "{{client.photo}}",
    "primaryStaff": {
      "id": "{{client.primaryStaff.id}}",
      "name": "{{client.primaryStaff.name}}"
    },
    "primaryLocation": {
      "id": "{{client.primaryLocation.id}}",
      "title": "{{client.primaryLocation.title}}"
    },
    "emergencyRelationType": "{{client.emergencyRelationType}}",
    "emergencyName": "{{client.emergencyName}}",
    "emergencyCountryCode": "{{client.emergencyCountryCode}}",
    "emergencyPhone": "{{client.emergencyPhone}}",
    "customFields": "{{client.customFields}}",
    "createdAt": "{{client.createdAt}}",
    "updatedAt": "{{client.updatedAt}}"
  }
}
```

(ii) Client Added test Payload data 👇

```json
{
  "event": {
    "id": "ecKyX3x8IY",
    "type": "client_created",
    "timeStamp": "2024-03-17T09:00:00Z",
    "key": "bXcgZ2xXbCU"
  },
  "client": {
    "id": "bXcgZ2xXbCU",
    "clientId": "CLNT001",
    "fullName": "John Doe",
    "preferredName": "John",
    "contactType": "MOBILE",
    "countryCode": "+1",
    "phone": "1234567890",
    "email": "john.doe@example.com",
    "registrationDate": "2022-01-01",
    "dob": "1985-05-20",
    "addressType": "HOME",
    "address": "123 Main Street, Cityville, USA",
    "identificationNumber": "ID123456789",
    "gender": "male",
    "preferredLanguage": "English",
    "maritalStatus": "single",
    "tags": "["VIP","Preferred"]",
    "notes": "Regular customer, prefers morning appointments",
    "referralSource": "Friend referral",
    "photo": "https://example.com/john_doe_photo.jpg",
    "primaryStaff": {
      "id": "JXcDx3h8IZ",
      "name": "Sarah Smith"
    },
    "primaryLocation": {
      "id": "LXhX3x8QYI",
      "title": "Main Location"
    },
    "emergencyRelationType": "family",
    "emergencyName": "Jane Doe",
    "emergencyCountryCode": "+1",
    "emergencyPhone": "9876543210",
    "customFields": "{"membership":"Gold","preferredTime":"Morning"}",
    "createdAt": "2022-01-01T12:00:00Z",
    "updatedAt": "2024-03-17T10:30:00Z"
  }
}
```

***

## Client Tag Added

**(i) Payload Format:** Client Tag Added Payload data format and content that Whautomate will transmit to the configured endpoint.

```json
{
  "event": {
    "id": "{{event.id}}",
    "type": "{{event.type}}",
    "timeStamp": "{{event.timeStamp}}",
    "key": "{{event.key}}"
  },
  "client": {
    "id": "{{client.id}}",
    "clientId": "{{client.clientId}}",
    "fullName": "{{client.fullName}}",
    "preferredName": "{{client.preferredName}}",
    "contactType": "{{client.contactType}}",
    "countryCode": "{{client.countryCode}}",
    "phone": "{{client.phone}}",
    "email": "{{client.email}}",
    "registrationDate": "{{client.registrationDate}}",
    "dob": "{{client.dob}}",
    "addressType": "{{client.addressType}}",
    "address": "{{client.address}}",
    "identificationNumber": "{{client.identificationNumber}}",
    "gender": "{{client.gender}}",
    "preferredLanguage": "{{client.preferredLanguage}}",
    "maritalStatus": "{{client.maritalStatus}}",
    "addedTags": "{{client.addedTags}}",
    "tags": "{{client.tags}}",
    "notes": "{{client.notes}}",
    "referralSource": "{{client.referralSource}}",
    "photo": "{{client.photo}}",
    "primaryStaff": {
      "id": "{{client.primaryStaff.id}}",
      "name": "{{client.primaryStaff.name}}"
    },
    "primaryLocation": {
      "id": "{{client.primaryLocation.id}}",
      "title": "{{client.primaryLocation.title}}"
    },
    "emergencyRelationType": "{{client.emergencyRelationType}}",
    "emergencyName": "{{client.emergencyName}}",
    "emergencyCountryCode": "{{client.emergencyCountryCode}}",
    "emergencyPhone": "{{client.emergencyPhone}}",
    "customFields": "{{client.customFields}}",
    "createdAt": "{{client.createdAt}}",
    "updatedAt": "{{client.updatedAt}}"
  }
}
```

(ii) Client Tag Added test Payload data 👇

```json
{
  "event": {
    "id": "ecKyX3x8IY",
    "type": "client_tag_added",
    "timeStamp": "2024-03-17T09:00:00Z",
    "key": "bXcgZ2xXbCU"
  },
  "client": {
    "id": "bXcgZ2xXbCU",
    "clientId": "CLNT001",
    "fullName": "John Doe",
    "preferredName": "John",
    "contactType": "MOBILE",
    "countryCode": "+1",
    "phone": "1234567890",
    "email": "john.doe@example.com",
    "registrationDate": "2022-01-01",
    "dob": "1985-05-20",
    "addressType": "HOME",
    "address": "123 Main Street, Cityville, USA",
    "identificationNumber": "ID123456789",
    "gender": "male",
    "maritalStatus": "single",
    "addedTags": "["VIP"]",
    "tags": "["VIP","Preferred"]",
    "notes": "Regular customer, prefers morning appointments",
    "referralSource": "Friend referral",
    "photo": "https://example.com/john_doe_photo.jpg",
    "primaryStaff": {
      "id": "JXcDx3h8IZ",
      "name": "Sarah Smith"
    },
    "primaryLocation": {
      "id": "LXhX3x8QYI",
      "title": "Main Location"
    },
    "emergencyRelationType": "family",
    "emergencyName": "Jane Doe",
    "emergencyCountryCode": "+1",
    "emergencyPhone": "9876543210",
    "customFields": "{"membership":"Gold","preferredTime":"Morning"}",
    "createdAt": "2022-01-01T12:00:00Z",
    "updatedAt": "2024-03-17T10:30:00Z"
  }
}
```

***

## Client Tag Removed

**(i) Payload Format:** Client Tag Removed Payload data format and content that Whautomate will transmit to the configured endpoint.

```json
{
  "event": {
    "id": "{{event.id}}",
    "type": "{{event.type}}",
    "timeStamp": "{{event.timeStamp}}",
    "key": "{{event.key}}"
  },
  "client": {
    "id": "{{client.id}}",
    "clientId": "{{client.clientId}}",
    "fullName": "{{client.fullName}}",
    "preferredName": "{{client.preferredName}}",
    "contactType": "{{client.contactType}}",
    "countryCode": "{{client.countryCode}}",
    "phone": "{{client.phone}}",
    "email": "{{client.email}}",
    "registrationDate": "{{client.registrationDate}}",
    "dob": "{{client.dob}}",
    "addressType": "{{client.addressType}}",
    "address": "{{client.address}}",
    "identificationNumber": "{{client.identificationNumber}}",
    "gender": "{{client.gender}}",
    "preferredLanguage": "{{client.preferredLanguage}}",
    "maritalStatus": "{{client.maritalStatus}}",
    "removedTags": "{{client.removedTags}}",
    "tags": "{{client.tags}}",
    "notes": "{{client.notes}}",
    "referralSource": "{{client.referralSource}}",
    "photo": "{{client.photo}}",
    "primaryStaff": {
      "id": "{{client.primaryStaff.id}}",
      "name": "{{client.primaryStaff.name}}"
    },
    "primaryLocation": {
      "id": "{{client.primaryLocation.id}}",
      "title": "{{client.primaryLocation.title}}"
    },
    "emergencyRelationType": "{{client.emergencyRelationType}}",
    "emergencyName": "{{client.emergencyName}}",
    "emergencyCountryCode": "{{client.emergencyCountryCode}}",
    "emergencyPhone": "{{client.emergencyPhone}}",
    "customFields": "{{client.customFields}}",
    "createdAt": "{{client.createdAt}}",
    "updatedAt": "{{client.updatedAt}}"
  }
}
```

(ii) Client Tag Removed test Payload data 👇

```json
{
  "event": {
    "id": "ecKyX3x8IY",
    "type": "client_tag_added",
    "timeStamp": "2024-03-17T09:00:00Z",
    "key": "bXcgZ2xXbCU"
  },
  "client": {
    "id": "bXcgZ2xXbCU",
    "clientId": "CLNT001",
    "fullName": "John Doe",
    "preferredName": "John",
    "contactType": "MOBILE",
    "countryCode": "+1",
    "phone": "1234567890",
    "email": "john.doe@example.com",
    "registrationDate": "2022-01-01",
    "dob": "1985-05-20",
    "addressType": "HOME",
    "address": "123 Main Street, Cityville, USA",
    "identificationNumber": "ID123456789",
    "gender": "male",
    "preferredLanguage": "English",
    "maritalStatus": "single",
    "removedTags": "["Preferred"]",
    "tags": "["VIP"]",
    "notes": "Regular customer, prefers morning appointments",
    "referralSource": "Friend referral",
    "photo": "https://example.com/john_doe_photo.jpg",
    "primaryStaff": {
      "id": "JXcDx3h8IZ",
      "name": "Sarah Smith"
    },
    "primaryLocation": {
      "id": "LXhX3x8QYI",
      "title": "Main Location"
    },
    "emergencyRelationType": "family",
    "emergencyName": "Jane Doe",
    "emergencyCountryCode": "+1",
    "emergencyPhone": "9876543210",
    "customFields": "{"membership":"Gold","preferredTime":"Morning"}",
    "createdAt": "2022-01-01T12:00:00Z",
    "updatedAt": "2024-03-17T10:30:00Z"
  }
}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://help.whautomate.com/product-guides/integrations/webhooks/clients.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.