---
title: "Clinic client created"
method: POST
path: "clinic_client.created"
tags: ["webhooks"]
---

# Clinic client created

`POST clinic_client.created` (webhook)

Triggered when a new clinic client is created.

## Payload

- ClinicClientCreatedWebhookPayload
  - `data` object, required
    - `calendar_notes` string, required: The notes on the client.
    - `can_be_called` boolean, required: Whether the clinic can call the client.
    - `clinic_id` integer, required: The ID of the clinic this client belongs to.
    - `created` string, date-time, required: The datetime this object was created.
    - `deleted` string, date-time, nullable, required: The datetime this record was soft deleted.
    - `external_id` string, nullable, required: The ID from a clinic's legacy PIMS system, if the data was imported from there.
    - `has_unread_messages_for_clinic` boolean, required: Whether there are unread inbound messages from the client (for clinic's perspective)
    - `id` integer, required: The ID of the clinic client
    - `is_active` boolean, required: Whether the client is active.
    - `is_co_ownership_client` boolean, required: Whether this client has multiple users (co-owners) associated with it. The first_name and last_name fields on this Client represent the primary ClientUser only. Use the /clinic-client-users/ endpoints to view and manage all ClientUsers for this Client.
    - `is_deleted` boolean, required: Whether this record is soft deleted or not.
    - `is_email_unsubscribed` boolean, nullable, required: Whether the client has unsubscribed from marketing emails, if they have an email on file. A null value indicates they do not have an email on file.
    - `is_subscribed` boolean, required: Whether the client is subscribed to receive info from the clinic.
    - `last_visit_date` string, date-time, nullable, required: The date of the client's most recent appointment or invoice.
    - `modified` string, date-time, required: The datetime this object was last modified; changes to related entities will not update this field.
    - `pim_id` string, nullable, required: The ID of the clinic client in the clinic's PIMS.
    - `primary_address` ExternalAddressSchema
      - `address_one` string, required: The first line of the address.
      - `address_two` string: The second line of the address.
      - `city` string, required: The city of the address.
      - `country` 'CA' | 'US' | 'AS' | 'GU' | 'MP' | 'PR' | 'VI'
      - `county` string: The county of the address.
      - `id` integer, required: The ID of the address.
      - `name` string: The name of the address.
      - `phone_number` integer, nullable: The phone number of the address.
      - `state` string, required: The 2-letter code of the state/province/region of the address. Legacy data could deviate from the 2-letter code convention.
      - `zipcode` string, required: The zip code/postal code of the address.
    - `primary_client_user.first_name` string, nullable: The first name of the primary clinic client user. For clinic clients with multiple clinic client users (has_multiple_users=true), this represents only the primary clinic client user's name.
    - `primary_client_user.last_name` string, nullable: The last name of the primary clinic client user. For clinic clients with multiple clinic client users (has_multiple_users=true), this represents only the primary clinic client user's name.
    - `primary_client_user_id` integer, nullable, required: The ID of the primary ClientUser (account owner) for this client. This is the 'main' owner whose name is reflected in the Client's `first_name` and `last_name` fields.
    - `primary_communication_number_int` integer, nullable: The primary phone number for this client account. This is selected from the available contact methods across all ClientUsers. When updating via the Client update endpoint, changes are applied to the primary ClientUser.
    - `primary_email_address_str` string, nullable: The primary email address for this client account. This is selected from the available contact methods across all ClientUsers. When updating via the Client update endpoint, changes are applied to the primary ClientUser.
    - `primary_payment_method_id` integer, nullable: The ID of the primary payment method of the clinic client
    - `universal_client_id` integer, nullable, required: The organization client ID corresponding to this clinic client.
  - `type` 'clinic_client.created', required: The event type identifier.

## Acknowledgement `200`

Webhook received

---

[API](https://skmtc.dev/vetcove/apis/ninjaapi.md) - [All operations](https://skmtc.dev/vetcove/apis/ninjaapi/llms.txt) - [OpenAPI document](https://skmtc.dev/vetcove/apis/ninjaapi/revisions/4ceaed956e15?raw)