Skip to content
Webhook
/
Mock webhook request

API Documentation (1.22)

Download OpenAPI description
index.json
index.yaml
Languages
Servers
Sandbox

https://api-developer-sandbox.zocdoc.com/

Production

https://api-developer.zocdoc.com/

NPIs

Endpoints to retrieve information about the developer's directory.

Operations

Schedulable entities

Endpoints to retrieve schedulable entities with availability information.

Operations

Insurance

Endpoints to retrieve insurance plans supported by Zocdoc.

Operations

Providers

Endpoints to retrieve providers within the developer's directory.

Operations

Provider locations

Endpoints for retrieving and modifying provider location objects and their related reviews, insurance plans, and availability.

Operations

Facilities

Endpoints to retrieve facilities within the developer's directory.

Operations

Calendar integration timeslots

Endpoints to manage timeslots for providers.

Operations

Appointments

Endpoints for booking, cancelling, and rescheduling appointments, including retrieving current appointment statuses and updated information.

Operations

Webhook

Sandbox endpoints to mock webhook behavior

Operations

Mock webhook request

Request

Security
ClientCredentialsFlow
Bodyapplication/json
webhook_urlstringrequired

a valid url to receive the mock webhook request

webhook_keystringrequired

a valid key for the signature in base64 format

appointment_update_typestring(AppointmentUpdateType)
Enum"updated""cancelled""created"
curl -i -X POST \
  https://api-developer-sandbox.zocdoc.com/v1/webhook/mock-request \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "webhook_url": "string",
    "webhook_key": "string",
    "appointment_update_type": "updated"
  }'

Responses

Successful

Bodyapplication/json
event_typestringrequired
webhook_timestampstringrequired
dataobject(WebhookMockRequestData)required
data.​data_typestringrequired
data.​appointment_dataobject(WebhookMockAppointmentData)required
data.​appointment_data.​appointment_idstringrequired
data.​appointment_data.​appointment_updated_timestampstringrequired
data.​appointment_data.​appointment_update_typestring(AppointmentUpdateType)required
Enum"updated""cancelled""created"
data.​appointment_data.​changed_attributesArray of objects(ChangedAttribute)

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.

Response
application/json
{
  "event_type": "string",
  "webhook_timestamp": "string",
  "data": {
    "data_type": "string",
    "appointment_data": { … }
  }
}
Copyright © Zocdoc Inc. All rights reserved.