Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zocdoc webhook API

Sandbox endpoints to mock webhook behavior

Zocdoc webhook API is one of 10 APIs that Zocdoc publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include webhook. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and a changelog.

This API exposes 1 operation across 1 path, and defines 10 schemas. It is described by OpenAPI 3.0.0, at version 1.176.

Requests are made against 2 base URLs: https://api-developer-sandbox.zocdoc.com, https://api-developer.zocdoc.com.

1 operations 1 paths 10 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.176
Base URL
https://api-developer.zocdoc.com
Authentication
OAuth 2.0, OAuth 2.0
Resource Areas
1

Authentication & Security 2

Zocdoc webhook API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (ClientCredentialsFlow) using the clientCredentials flow, exposing 6 scopes. It supports OAuth 2.0 (AuthorizationCodeFlow) using the authorizationCode flow, exposing 3 scopes.

  • ClientCredentialsFlow — Machine to machine authentication (for use from client server to Zocdoc). Production: https://auth.zocdoc.com/oauth/token Sandbox: https://auth-api-developer-s…
  • AuthorizationCodeFlow — Log in as a user. Client Secret is not necessary for this login flow. Production: https://auth.zocdoc.com Sandbox: https://auth-api-developer-sandbox.zocdoc.com

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

webhook 1

Sandbox endpoints to mock webhook behavior

POST
/v1/webhook/mock-request
Mock webhook request
mockWebhookRequest body → 200400401403404

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are WebhookMockAppointmentData (4 properties), WebhookMockDataRequest (3 properties), WebhookMockResponse (3 properties), WebhookMockRequestData (2 properties). Each schema is shown below with its type and property counts.

ErrorType
string
BaseResult
object
1 property 1 required
WebhookMockRequestData
object
2 properties 2 required
WebhookMockAppointmentData
object
4 properties 3 required
ChangedAttribute
object
2 properties 1 required
AppointmentUpdateType
string
Error
object
2 properties 1 required
WebhookMockDataRequest
object
3 properties 2 required
ErrorResult
WebhookMockResponse
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zocdoc-webhook-api-openapi.yml Raw ↑

Other APIs Zocdoc publishes across the network.

Zocdoc appointments API
Zocdoc calendar-integration-timeslots API
Zocdoc credentials API
Zocdoc facilities API
Zocdoc insurance-reference API
Zocdoc provider-locations API
Zocdoc providers API
Zocdoc reference API
Zocdoc schedulable-entities API