---
title: "Update appointment"
method: POST
path: "/registered_url_for_update_appointment_events"
tags: ["Appointment Webhooks"]
---

# Update appointment

`POST /registered_url_for_update_appointment_events`

When an appointment is updated, a webhook event is sent to registered webhooks with details about the appointment, including the appointment ID, status, doctor ID, patient ID, and event type.

**Field Definitions**

• **event**: string - The type of resource for which event is generated. For appointments updated, this will be `appointment.updated`.

• **service**: string - The type of service. For appointments, this will be `appointment`.

• **data**: object - Contains detailed information about the appointment event.

• **appointment_id**: string - Unique identifier for the appointment.

• **doctor_id**: string - Unique identifier for the doctor.

• **patient_id**: string - Unique identifier for the patient.

• **status**: string - Status of the appointment. Possible values can be 

  - "BK" (Booked),

  - "OG" (Ongoing),

  - "CM" (Completed with Prescription),

  - "CMNP" (Completed without Prescription),

  - "CN" (Cancelled).


• **action**: string - Current action for the appointment. Possible values can be 

    - created

    - modified

    - completed

• **partner_meta**: key value pair specified by `partner` while creating appointment.  

• **timestamp**: string (ISO 8601) - The date and time when the event occurred.

• **custom_attibutes**: complete set of custom attributes(inclusing tags and labels) defined against this appointment. occurred.

**Example Webhook Request**

**Endpoint:** [https://your-registered-webhook-url.com](https://your-registered-webhook-url.com)

**Method:** POST

## Request body

- object
  - `service` string — Type of serivce
  - `event` string, required — Type of event
  - `transaction_id` string — Transaction ID for the appointment
  - `event_time` integer, required — Event occured timestamp
  - `timestamp` integer, required — Timestamp of the event
  - `client_id` string, required — Client ID for the appointment
  - `business_id` string, required — Business ID for the appointment
  - `data` object, required
    - `appointment_id` string, required — Unique appointment ID
    - `partner_appointment_id` string, required — Partner's appointment ID
    - `doctor_id` string, required — Identifier for the doctor in Eka
    - `partner_doctor_id` string, required — Identifier for the partner’s doctor
    - `patient_id` string, required — Identifier for the patient in Eka
    - `partner_patient_id` string, required — Identifier for the partner’s patient
    - `clinic_id` string, required — Identifier for the clinic in Eka
    - `partner_clinic_id` string, required — Identifier for the partner’s clinic
    - `status` string, required — Status of the appointment
    - `action` string, required — Action performed
    - `created_at` integer, required — Creation timestamp
    - `modified_at` integer, required — Modification timestamp
    - `custom_attributes` object — Custom attributes for the event
      - `label` string[]
    - `partner_meta` object, required — Partner-specific metadata
      - `key1` string
    - `sa_ids` string[], required — List of SA IDs

## Response `200`

---

[API](https://skmtc.net/eka/apis/eka-developer-apis.md) · [All operations](https://skmtc.net/eka/apis/eka-developer-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/eka/eka-developer-apis/versions/9ea23456f722/schema)