---
title: "Mock webhook request"
method: POST
path: "/v1/webhook/mock-request"
tags: ["webhook"]
---

# Mock webhook request

`POST /v1/webhook/mock-request`

## Request

- Base URL: `https://api-developer-sandbox.zocdoc.com`
- URL: `https://api-developer-sandbox.zocdoc.com/v1/webhook/mock-request`
- Auth: one of:
  - OAuth 2
    - Client credentials
    - Token URL: `https://auth.zocdoc.com/oauth/token`
  - OAuth 2
    - Authorization code: `https://auth.zocdoc.com/authorize`
    - Token URL: `https://auth.zocdoc.com/oauth/token`

## Request body

- WebhookMockDataRequest
  - `webhook_url` string, required: a valid url to receive the mock webhook request
  - `webhook_key` string, required: a valid key for the signature in base64 format
  - `appointment_update_type` 'updated' | 'cancelled' | 'created'

## Response `200`

Successful

- WebhookMockResponse
  - `event_type` string, required
  - `webhook_timestamp` string, required
  - `data` WebhookMockRequestData, required
    - `data_type` string, required
    - `appointment_data` WebhookMockAppointmentData, required
      - `appointment_id` string, required
      - `practice_id` string: The Zocdoc id of the practice the appointment belongs to. Optional. On real webhooks the key is omitted entirely (absent, not `null`) unless your app client is enabled for the field and the event carries a practice id, so parse for a key that may be missing. This field is currently for select partners. If you are unsure if you have access, please contact Zocdoc.
      - `appointment_updated_timestamp` string, required
      - `appointment_update_type` 'updated' | 'cancelled' | 'created', required
      - `changed_attributes` AppointmentChangedAttribute[]: Array of changed attributes when webhook is triggered due to attribute changes. Each object must contain at least an attribute_path indicating the changed field.
        - `attribute_path` string, required: The path to the changed attribute in dot notation (e.g., "appointment.start_time", "patient.uploaded_attachments")
        - `attachment_type` string: Required when attribute_path is "patient.uploaded_attachments", indicates the type of attachment

## Other responses

- `400`: Bad request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not found

---

[API](https://skmtc.dev/zocdoc/apis/zocdoc-bundle-api.md) - [All operations](https://skmtc.dev/zocdoc/apis/zocdoc-bundle-api/llms.txt) - [OpenAPI document](https://skmtc.dev/zocdoc/apis/zocdoc-bundle-api/revisions/965a6ca4ed12?raw)