> For the complete documentation index, see [llms.txt](https://docs.welkinhealth.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.welkinhealth.com/admin/apis-and-integrations/webhook-events.md).

# Webhook Events

Every event that can trigger an automation or webhook, and the payload Welkin sends when one fires.

Welkin can call your endpoint when something happens in the platform. There are **212 events** across **58 objects**.

***

## How webhooks are triggered

Welkin webhooks do not have their own event subscription. A webhook is an **action inside an automation**, and the automation's trigger decides when it fires.

To receive an event:

1. Register the webhook endpoint in **Admin → Webhooks**
2. In **Designer**, create an automation with an **Event** trigger
3. Choose the object (`eventEntity`) and optionally a specific event (`eventSubtype`)
4. Add the webhook as the automation's action

Selecting only an object delivers **every** event for it. Narrow it with a subtype.

***

## Payload

Every event sends the **same flat JSON envelope** — there is no per-event payload schema. Identify the event from the `eventEntity` and `eventSubtype` fields.

| Field          | Type   | Description                                                                    |
| -------------- | ------ | ------------------------------------------------------------------------------ |
| `instanceName` | string | The environment the event occurred in, e.g. `live` or `sandbox`.               |
| `tenantName`   | string | Your organization (tenant) identifier.                                         |
| `sourceName`   | string | Machine-readable name of the record that triggered the event, e.g. a CDT name. |
| `sourceId`     | uuid   | Identifier of the record that triggered the event.                             |
| `patientId`    | uuid   | The patient the event relates to. Omitted for events with no patient context.  |
| `eventEntity`  | string | The object the event relates to, e.g. `PATIENT`. See the catalogue below.      |
| `eventSubtype` | string | The specific event, e.g. `PATIENT_CREATED`. See the catalogue below.           |
| `url`          | string | API URL for fetching the affected record. Omitted when it cannot be resolved.  |

Fields resolving to `null` are omitted, so a payload contains only what applies to that event.

### Custom fields

Any custom fields configured on the webhook in Admin are merged into the same top-level object. Because they are per-webhook, they are not listed here — check your own configuration.

### Example

```json
{
  "tenantName": "acme-health",
  "instanceName": "live",
  "eventEntity": "PATIENT",
  "eventSubtype": "PATIENT_CREATED",
  "patientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "sourceName": "patient",
  "sourceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "url": "https://api.live.welkincloud.io/acme-health/live/patients/3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
```

Delivery attempts are recorded in **Admin → Audit → Webhook Audit**.

***

## Event catalogue

212 events, grouped by object. Use the object as `eventEntity` and the event as `eventSubtype`.

### Acuity Service

`eventEntity`: `ACUITY_SERVICE` — 3 events

| Event                            | Description                    |
| -------------------------------- | ------------------------------ |
| `ACUITY_APPOINTMENT_CREATED`     | Acuity Appointment Created     |
| `ACUITY_APPOINTMENT_RESCHEDULED` | Acuity Appointment Rescheduled |
| `ACUITY_APPOINTMENT_CANCELED`    | Acuity Appointment Canceled    |

### Api Client

`eventEntity`: `API_CLIENT` — 3 events

| Event                 | Description         |
| --------------------- | ------------------- |
| `API_CLIENT_ENABLED`  | Api Client Enabled  |
| `API_CLIENT_DISABLED` | Api Client Disabled |
| `API_CLIENT_CREATED`  | Api Client Created  |

### Api Client App Access

`eventEntity`: `API_CLIENT_APP_ACCESS` — 2 events

| Event                       | Description               |
| --------------------------- | ------------------------- |
| `API_CLIENT_ACCESS_CREATED` | Api Client Access Created |
| `API_CLIENT_ACCESS_UPDATED` | Api Client Access Updated |

### Api Client Permission

`eventEntity`: `API_CLIENT_PERMISSION` — 2 events

| Event                           | Description                   |
| ------------------------------- | ----------------------------- |
| `API_CLIENT_PERMISSION_UPDATED` | Api Client Permission Updated |
| `API_CLIENT_PERMISSION_CREATED` | Api Client Permission Created |

### Api Client Territory

`eventEntity`: `API_CLIENT_TERRITORY` — 2 events

| Event                          | Description                  |
| ------------------------------ | ---------------------------- |
| `API_CLIENT_TERRITORY_UPDATED` | Api Client Territory Updated |
| `API_CLIENT_TERRITORY_CREATED` | Api Client Territory Created |

### Assessment

`eventEntity`: `ASSESSMENT` — 6 events

| Event                            | Description                    |
| -------------------------------- | ------------------------------ |
| `ASSESSMENT_CREATED`             | Assessment Created             |
| `ASSESSMENT_IN_PROGRESS`         | Assessment In Progress         |
| `ASSESSMENT_SUBMITTED`           | Assessment Submitted           |
| `ASSESSMENT_PARTIALLY_COMPLETED` | Assessment Partially Completed |
| `ASSESSMENT_COMPLETED`           | Assessment Completed           |
| `ASSESSMENT_EXPIRED`             | Assessment Expired             |

### Assessment Migration

`eventEntity`: `ASSESSMENT_MIGRATION` — 1 event

| Event                               | Description                       |
| ----------------------------------- | --------------------------------- |
| `DATA_MIGRATION_ASSESSMENT_UPDATED` | Data Migration Assessment Updated |

### Automation

`eventEntity`: `AUTOMATION` — 1 event

| Event                  | Description          |
| ---------------------- | -------------------- |
| `RECURRING_AUTOMATION` | Recurring Automation |

### Availability

`eventEntity`: `AVAILABILITY` — 3 events

| Event                  | Description          |
| ---------------------- | -------------------- |
| `AVAILABILITY_CREATED` | Availability Created |
| `AVAILABILITY_UPDATED` | Availability Updated |
| `AVAILABILITY_DELETED` | Availability Deleted |

### Calendar

`eventEntity`: `CALENDAR` — 3 events

| Event                    | Description            |
| ------------------------ | ---------------------- |
| `CALENDAR_EVENT_CREATED` | Calendar Event Created |
| `CALENDAR_EVENT_UPDATED` | Calendar Event Updated |
| `CALENDAR_EVENT_DELETED` | Calendar Event Deleted |

### Calendar Service

`eventEntity`: `CALENDAR_SERVICE` — 1 event

| Event                             | Description                     |
| --------------------------------- | ------------------------------- |
| `EXTERNAL_CALENDAR_EVENT_UPDATED` | External Calendar Event Updated |

### Calendar Work Hours

`eventEntity`: `CALENDAR_WORK_HOURS` — 3 events

| Event                         | Description                 |
| ----------------------------- | --------------------------- |
| `CALENDAR_WORK_HOURS_CREATED` | Calendar Work Hours Created |
| `CALENDAR_WORK_HOURS_UPDATED` | Calendar Work Hours Updated |
| `CALENDAR_WORK_HOURS_DELETED` | Calendar Work Hours Deleted |

### Candid Request

`eventEntity`: `CANDID_REQUEST` — 2 events

| Event                       | Description               |
| --------------------------- | ------------------------- |
| `CANDID_CREATION_REQUESTED` | Candid Creation Requested |
| `CANDID_PAYMENT_RECEIVED`   | Candid Payment Received   |

### Candid Response

`eventEntity`: `CANDID_RESPONSE` — 4 events

| Event                      | Description              |
| -------------------------- | ------------------------ |
| `CANDID_AUDIT_LOG_CREATED` | Candid Audit Log Created |
| `CANDID_CLAIMS_CREATED`    | Candid Claims Created    |
| `CANDID_CLAIMS_UPDATED`    | Candid Claims Updated    |
| `CANDID_CLAIMS_FAILED`     | Candid Claims Failed     |

### Cdt

`eventEntity`: `CDT` — 5 events

| Event                   | Description           |
| ----------------------- | --------------------- |
| `CDT_UPDATED`           | Cdt Updated           |
| `CDT_CREATED`           | Cdt Created           |
| `CDT_DELETED`           | Cdt Deleted           |
| `BEFORE_SPECIFIED_DATE` | Before Specified Date |
| `AFTER_SPECIFIED_DATE`  | After Specified Date  |

### Chat

`eventEntity`: `CHAT` — 3 events

| Event                  | Description          |
| ---------------------- | -------------------- |
| `CHAT_UNREAD_MESSAGE`  | Chat Unread Message  |
| `CHAT_MESSAGE_SENT`    | Chat Message Sent    |
| `CHAT_MESSAGE_UPDATED` | Chat Message Updated |

### Communication

`eventEntity`: `COMMUNICATION` — 1 event

| Event                          | Description                  |
| ------------------------------ | ---------------------------- |
| `UNSUPPORTED_WHATSAPP_MESSAGE` | Unsupported Whatsapp Message |

### Communication Data Audit

`eventEntity`: `COMMUNICATION_DATA_AUDIT` — 1 event

| Event                      | Description              |
| -------------------------- | ------------------------ |
| `INTERNAL_MESSAGE_DELETED` | Internal Message Deleted |

### Concurrency Settings *(platform configuration)*

`eventEntity`: `CONCURRENCY_SETTINGS` — 1 event

| Event                          | Description                  |
| ------------------------------ | ---------------------------- |
| `CONCURRENCY_SETTINGS_UPDATED` | Concurrency Settings Updated |

### Contact

`eventEntity`: `CONTACT` — 2 events

| Event             | Description     |
| ----------------- | --------------- |
| `CONTACT_CREATED` | Contact Created |
| `CONTACT_UPDATED` | Contact Updated |

### Document

`eventEntity`: `DOCUMENT` — 2 events

| Event                                   | Description                           |
| --------------------------------------- | ------------------------------------- |
| `DOCUMENT_UPLOADED`                     | Document Uploaded                     |
| `DOCUMENT_SUPERVISOR_SIGNATURE_AWAITED` | Document Supervisor Signature Awaited |

### Email

`eventEntity`: `EMAIL` — 4 events

| Event                               | Description                       |
| ----------------------------------- | --------------------------------- |
| `EMAIL_UNREAD_MESSAGE`              | Email Unread Message              |
| `UNRECOGNIZED_EMAIL_UNREAD_MESSAGE` | Unrecognized Email Unread Message |
| `EMAIL_SENT`                        | Email Sent                        |
| `EMAIL_UPDATED`                     | Email Updated                     |

### Encounter

`eventEntity`: `ENCOUNTER` — 9 events

| Event                              | Description                      |
| ---------------------------------- | -------------------------------- |
| `ENCOUNTER_CREATED`                | Encounter Created                |
| `ENCOUNTER_OPENED`                 | Encounter Opened                 |
| `ENCOUNTER_FINALIZED`              | Encounter Finalized              |
| `ENCOUNTER_CANCELLED`              | Encounter Cancelled              |
| `BEFORE_ENCOUNTER_STARTED`         | Before Encounter Started         |
| `AFTER_ENCOUNTER_FINISHED`         | After Encounter Finished         |
| `ENCOUNTER_PRE_VISIT_COST_SET`     | Encounter Pre Visit Cost Set     |
| `ENCOUNTER_PRE_VISIT_COST_UPDATED` | Encounter Pre Visit Cost Updated |
| `ENCOUNTER_RESCHEDULED`            | Encounter Rescheduled            |

### Encounter Disposition

`eventEntity`: `ENCOUNTER_DISPOSITION` — 3 events

| Event                                     | Description                             |
| ----------------------------------------- | --------------------------------------- |
| `ENCOUNTER_DISPOSITION_CREATED`           | Encounter Disposition Created           |
| `ENCOUNTER_DISPOSITION_UPDATED`           | Encounter Disposition Updated           |
| `ENCOUNTER_DISPOSITION_FINALIZED_UPDATED` | Encounter Disposition Finalized Updated |

### Encounter Payment Info

`eventEntity`: `ENCOUNTER_PAYMENT_INFO` — 1 event

| Event                            | Description                    |
| -------------------------------- | ------------------------------ |
| `ENCOUNTER_PAYMENT_INFO_UPDATED` | Encounter Payment Info Updated |

### Fax

`eventEntity`: `FAX` — 12 events

| Event                   | Description           |
| ----------------------- | --------------------- |
| `FAX_CREATED`           | Fax Created           |
| `FAX_UPDATED`           | Fax Updated           |
| `FAX_SENT`              | Fax Sent              |
| `FAX_DELIVERED`         | Fax Delivered         |
| `FAX_FAILED`            | Fax Failed            |
| `FAX_RECEIVED`          | Fax Received          |
| `FAX_REVIEWED`          | Fax Reviewed          |
| `FAX_DELETED`           | Fax Deleted           |
| `FAX_FILE_ADDED`        | Fax File Added        |
| `FAX_FILE_DELETED`      | Fax File Deleted      |
| `INBOUND_FAX_ASSIGNED`  | Inbound Fax Assigned  |
| `OUTBOUND_FAX_ASSIGNED` | Outbound Fax Assigned |

### Formation Version

`eventEntity`: `FORMATION_VERSION` — 1 event

| Event                         | Description                 |
| ----------------------------- | --------------------------- |
| `FORMATION_VERSION_PUBLISHED` | Formation Version Published |

### Goal

`eventEntity`: `GOAL` — 4 events

| Event            | Description    |
| ---------------- | -------------- |
| `GOAL_CREATED`   | Goal Created   |
| `GOAL_UPDATED`   | Goal Updated   |
| `GOAL_COMPLETED` | Goal Completed |
| `GOAL_REMOVED`   | Goal Removed   |

### Inbox Mention

`eventEntity`: `INBOX_MENTION` — 1 event

| Event                   | Description           |
| ----------------------- | --------------------- |
| `INBOX_MENTION_CREATED` | Inbox Mention Created |

### Inbox Message

`eventEntity`: `INBOX_MESSAGE` — 7 events

| Event                                         | Description                                 |
| --------------------------------------------- | ------------------------------------------- |
| `INBOX_SMS_MESSAGE_RECEIVED`                  | Inbox Sms Message Received                  |
| `INBOX_SMS_PATIENT_CONTACT_REASSIGNED`        | Inbox Sms Patient Contact Reassigned        |
| `INBOX_EMAIL_MESSAGE_RECEIVED`                | Inbox Email Message Received                |
| `INBOX_EMAIL_PATIENT_CONTACT_REASSIGNED`      | Inbox Email Patient Contact Reassigned      |
| `INBOX_CHAT_MESSAGE_RECEIVED`                 | Inbox Chat Message Received                 |
| `INBOX_VOICE_CALL_MESSAGE_RECEIVED`           | Inbox Voice Call Message Received           |
| `INBOX_VOICE_CALL_PATIENT_CONTACT_REASSIGNED` | Inbox Voice Call Patient Contact Reassigned |

### Inbox User Config

`eventEntity`: `INBOX_USER_CONFIG` — 1 event

| Event                            | Description                    |
| -------------------------------- | ------------------------------ |
| `INBOX_USER_NOTIFICATION_CONFIG` | Inbox User Notification Config |

### Instance *(platform configuration)*

`eventEntity`: `INSTANCE` — 5 events

| Event               | Description       |
| ------------------- | ----------------- |
| `INSTANCE_CREATED`  | Instance Created  |
| `INSTANCE_UPDATED`  | Instance Updated  |
| `INSTANCE_DELETED`  | Instance Deleted  |
| `INSTANCE_ARCHIVED` | Instance Archived |
| `INSTANCE_RESTORED` | Instance Restored |

### Invoice

`eventEntity`: `INVOICE` — 8 events

| Event                              | Description                      |
| ---------------------------------- | -------------------------------- |
| `DRAFT_INVOICE_CREATED`            | Draft Invoice Created            |
| `DRAFT_INVOICE_UPDATED`            | Draft Invoice Updated            |
| `DRAFT_INVOICE_DELETED`            | Draft Invoice Deleted            |
| `INVOICE_SENT`                     | Invoice Sent                     |
| `INVOICE_PREAUTHORIZED`            | Invoice Preauthorized            |
| `INVOICE_VOIDED`                   | Invoice Voided                   |
| `INVOICE_UPDATED`                  | Invoice Updated                  |
| `INVOICE_FOR_SUBSCRIPTION_CREATED` | Invoice For Subscription Created |

### Invoice Automation Result

`eventEntity`: `INVOICE_AUTOMATION_RESULT` — 4 events

| Event                      | Description              |
| -------------------------- | ------------------------ |
| `INVOICE_CREATION_SUCCEED` | Invoice Creation Succeed |
| `INVOICE_CREATION_FAILED`  | Invoice Creation Failed  |
| `PREAUTHORIZATION_SUCCEED` | Preauthorization Succeed |
| `PREAUTHORIZATION_FAILED`  | Preauthorization Failed  |

### Invoice Request

`eventEntity`: `INVOICE_REQUEST` — 3 events

| Event                                               | Description                                       |
| --------------------------------------------------- | ------------------------------------------------- |
| `INVOICE_CREATION_REQUESTED`                        | Invoice Creation Requested                        |
| `CAPTURE_PRE_AUTHORIZED_AMOUNT_REQUESTED`           | Capture Pre Authorized Amount Requested           |
| `CAPTURE_PRE_AUTHORIZED_CANCELLATION_FEE_REQUESTED` | Capture Pre Authorized Cancellation Fee Requested |

### License *(platform configuration)*

`eventEntity`: `LICENSE` — 3 events

| Event             | Description     |
| ----------------- | --------------- |
| `LICENSE_CREATED` | License Created |
| `LICENSE_UPDATED` | License Updated |
| `LICENSE_DELETED` | License Deleted |

### Log Level *(platform configuration)*

`eventEntity`: `LOG_LEVEL` — 1 event

| Event               | Description       |
| ------------------- | ----------------- |
| `LOG_LEVEL_UPDATED` | Log Level Updated |

### Patient

`eventEntity`: `PATIENT` — 5 events

| Event                       | Description               |
| --------------------------- | ------------------------- |
| `PATIENT_UPDATED`           | Patient Updated           |
| `PATIENT_CREATED`           | Patient Created           |
| `PATIENT_DELETED`           | Patient Deleted           |
| `PATIENT_CARE_TEAM_UPDATED` | Patient Care Team Updated |
| `PATIENT_POC_UPDATED`       | Patient Poc Updated       |

### Patient Program

`eventEntity`: `PATIENT_PROGRAM` — 6 events

| Event             | Description     |
| ----------------- | --------------- |
| `PROGRAM_CREATED` | Program Created |
| `PROGRAM_UPDATED` | Program Updated |
| `PROGRAM_DELETED` | Program Deleted |
| `PHASE_STARTED`   | Phase Started   |
| `PHASE_ENDED`     | Phase Ended     |
| `PHASE_CHANGED`   | Phase Changed   |

### Payment

`eventEntity`: `PAYMENT` — 4 events

| Event                       | Description               |
| --------------------------- | ------------------------- |
| `PAYMENT_CREATED`           | Payment Created           |
| `PAYMENT_CREATION_FAILED`   | Payment Creation Failed   |
| `PAYMENT_UPDATED`           | Payment Updated           |
| `PAYMENT_RELEASE_REQUESTED` | Payment Release Requested |

### Payment Audit

`eventEntity`: `PAYMENT_AUDIT` — 2 events

| Event                               | Description                       |
| ----------------------------------- | --------------------------------- |
| `PAYMENT_PRE_AUTHORIZATION_CREATED` | Payment Pre Authorization Created |
| `PAYMENT_PRE_AUTHORIZATION_UPDATED` | Payment Pre Authorization Updated |

### Payment Request

`eventEntity`: `PAYMENT_REQUEST` — 2 events

| Event                                   | Description                           |
| --------------------------------------- | ------------------------------------- |
| `PAYMENT_CREATION_REQUESTED`            | Payment Creation Requested            |
| `ENCOUNTER_PRE_AUTHORIZATION_INITIATED` | Encounter Pre Authorization Initiated |

### Pdt

`eventEntity`: `PDT` — 3 events

| Event         | Description |
| ------------- | ----------- |
| `PDT_UPDATED` | Pdt Updated |
| `PDT_CREATED` | Pdt Created |
| `PDT_DELETED` | Pdt Deleted |

### Phone Tree

`eventEntity`: `PHONE_TREE` — 4 events

| Event                           | Description                   |
| ------------------------------- | ----------------------------- |
| `PHONE_TREE_EXECUTED`           | Phone Tree Executed           |
| `PHONE_TREE_NODE_EXECUTED`      | Phone Tree Node Executed      |
| `PHONE_TREE_NODE_PART_EXECUTED` | Phone Tree Node Part Executed |
| `PHONE_TREE_WEBHOOK_EXECUTED`   | Phone Tree Webhook Executed   |

### Security Config *(platform configuration)*

`eventEntity`: `SECURITY_CONFIG` — 8 events

| Event                                     | Description                             |
| ----------------------------------------- | --------------------------------------- |
| `SECURITY_CONFIG_SSO_CREATED`             | Security Config Sso Created             |
| `SECURITY_CONFIG_SSO_UPDATED`             | Security Config Sso Updated             |
| `SECURITY_CONFIG_SSO_DELETED`             | Security Config Sso Deleted             |
| `SECURITY_CONFIG_PASSWORD_POLICY_UPDATED` | Security Config Password Policy Updated |
| `SECURITY_CONFIG_MFA_CREATED`             | Security Config Mfa Created             |
| `SECURITY_CONFIG_MFA_UPDATED`             | Security Config Mfa Updated             |
| `SECURITY_CONFIG_MFA_DELETED`             | Security Config Mfa Deleted             |
| `SESSION_CONFIG_UPDATED`                  | Session Config Updated                  |

### Shared Mailbox

`eventEntity`: `SHARED_MAILBOX` — 2 events

| Event                    | Description            |
| ------------------------ | ---------------------- |
| `SHARED_MAILBOX_CREATED` | Shared Mailbox Created |
| `SHARED_MAILBOX_UPDATED` | Shared Mailbox Updated |

### Sms

`eventEntity`: `SMS` — 4 events

| Event                             | Description                     |
| --------------------------------- | ------------------------------- |
| `SMS_UNREAD_MESSAGE`              | Sms Unread Message              |
| `UNRECOGNIZED_SMS_UNREAD_MESSAGE` | Unrecognized Sms Unread Message |
| `SMS_SENT`                        | Sms Sent                        |
| `SMS_UPDATED`                     | Sms Updated                     |

### Subscription

`eventEntity`: `SUBSCRIPTION` — 6 events

| Event                                     | Description                             |
| ----------------------------------------- | --------------------------------------- |
| `SUBSCRIPTION_INVOICE_CREATION_REQUESTED` | Subscription Invoice Creation Requested |
| `SUBSCRIPTION_INVOICE_CREATED`            | Subscription Invoice Created            |
| `SUBSCRIPTION_CREATED`                    | Subscription Created                    |
| `SUBSCRIPTION_UPDATED`                    | Subscription Updated                    |
| `SUBSCRIPTION_CANCELLED`                  | Subscription Cancelled                  |
| `SUBSCRIPTION_SUSPENDED`                  | Subscription Suspended                  |

### Task

`eventEntity`: `TASK` — 9 events

| Event                  | Description          |
| ---------------------- | -------------------- |
| `TASK_CREATED`         | Task Created         |
| `TASK_UPDATED`         | Task Updated         |
| `TASK_DELETED`         | Task Deleted         |
| `TASK_WATCHER_ADDED`   | Task Watcher Added   |
| `TASK_WATCHER_REMOVED` | Task Watcher Removed |
| `TASK_COMMENT_ADDED`   | Task Comment Added   |
| `TASK_COMMENT_REMOVED` | Task Comment Removed |
| `TASK_COMPLETED`       | Task Completed       |
| `TASK_CANCELED`        | Task Canceled        |

### Tenant *(platform configuration)*

`eventEntity`: `TENANT` — 2 events

| Event            | Description    |
| ---------------- | -------------- |
| `TENANT_DELETED` | Tenant Deleted |
| `TENANT_CREATED` | Tenant Created |

### Tenant License *(platform configuration)*

`eventEntity`: `TENANT_LICENSE` — 3 events

| Event                    | Description            |
| ------------------------ | ---------------------- |
| `TENANT_LICENSE_CREATED` | Tenant License Created |
| `TENANT_LICENSE_UPDATED` | Tenant License Updated |
| `TENANT_LICENSE_DELETED` | Tenant License Deleted |

### Unrecognized Communication

`eventEntity`: `UNRECOGNIZED_COMMUNICATION` — 12 events

| Event                            | Description                    |
| -------------------------------- | ------------------------------ |
| `EMAIL_REASSIGNED`               | Email Reassigned               |
| `EMAIL_RESTORED`                 | Email Restored                 |
| `EMAIL_DELETED`                  | Email Deleted                  |
| `EMAIL_DELETED_PERMANENTLY`      | Email Deleted Permanently      |
| `SMS_REASSIGNED`                 | Sms Reassigned                 |
| `SMS_RESTORED`                   | Sms Restored                   |
| `SMS_DELETED`                    | Sms Deleted                    |
| `SMS_DELETED_PERMANENTLY`        | Sms Deleted Permanently        |
| `VOICE_CALL_REASSIGNED`          | Voice Call Reassigned          |
| `VOICE_CALL_RESTORED`            | Voice Call Restored            |
| `VOICE_CALL_DELETED`             | Voice Call Deleted             |
| `VOICE_CALL_DELETED_PERMANENTLY` | Voice Call Deleted Permanently |

### User

`eventEntity`: `USER` — 8 events

| Event                            | Description                    |
| -------------------------------- | ------------------------------ |
| `USER_INVITED`                   | User Invited                   |
| `USER_PROVISIONED_BY_API_CLIENT` | User Provisioned By Api Client |
| `USER_ENABLED`                   | User Enabled                   |
| `USER_DISABLED`                  | User Disabled                  |
| `USER_PASSWORD_RESET`            | User Password Reset            |
| `USER_DETAILS_UPDATED`           | User Details Updated           |
| `USER_EMAIL_CHANGED`             | User Email Changed             |
| `ROOT_USER_CHANGED`              | Root User Changed              |

### User App Access

`eventEntity`: `USER_APP_ACCESS` — 2 events

| Event                 | Description         |
| --------------------- | ------------------- |
| `USER_ACCESS_CREATED` | User Access Created |
| `USER_ACCESS_UPDATED` | User Access Updated |

### User Permission

`eventEntity`: `USER_PERMISSION` — 2 events

| Event                     | Description             |
| ------------------------- | ----------------------- |
| `USER_PERMISSION_UPDATED` | User Permission Updated |
| `USER_PERMISSION_CREATED` | User Permission Created |

### User Territory

`eventEntity`: `USER_TERRITORY` — 2 events

| Event                    | Description            |
| ------------------------ | ---------------------- |
| `USER_TERRITORY_UPDATED` | User Territory Updated |
| `USER_TERRITORY_CREATED` | User Territory Created |

### Voice Call

`eventEntity`: `VOICE_CALL` — 6 events

| Event                                 | Description                         |
| ------------------------------------- | ----------------------------------- |
| `VOICE_CALL_INCOMING_CALL`            | Voice Call Incoming Call            |
| `VOICE_CALL_STARTED`                  | Voice Call Started                  |
| `VOICE_CALL_UPDATED`                  | Voice Call Updated                  |
| `VOICE_CALL_MISSED_CALL`              | Voice Call Missed Call              |
| `VOICE_CALL_MISSED_BY_RECEIVED_CALL`  | Voice Call Missed By Received Call  |
| `UNRECOGNIZED_VOICE_CALL_MISSED_CALL` | Unrecognized Voice Call Missed Call |

### Whatsapp

`eventEntity`: `WHATSAPP` — 2 events

| Event                                  | Description                          |
| -------------------------------------- | ------------------------------------ |
| `WHATSAPP_UNREAD_MESSAGE`              | Whatsapp Unread Message              |
| `UNRECOGNIZED_WHATSAPP_UNREAD_MESSAGE` | Unrecognized Whatsapp Unread Message |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://docs.welkinhealth.com/admin/apis-and-integrations/webhook-events.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.