ZOzocdoc
webhook

Mock webhook request

post/v1/webhook/mock-request

Request

  • Base URL
    https://api-developer-sandbox.zocdoc.com
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://auth.zocdoc.com/oauth/token
    • or OAuth 2
      Authorization code: https://auth.zocdoc.com/authorize
      Token URL: https://auth.zocdoc.com/oauth/token

Request body

webhook_urlstring required

a valid url to receive the mock webhook request

webhook_keystring required

a valid key for the signature in base64 format

appointment_update_type'updated' | 'cancelled' | 'created'

Response

Successful

event_typestring required
webhook_timestampstring required

Example response

{
  "data": {
    "appointment_data": {
      "practice_id": "pt_abc123-def456_wxyz7890",
      "changed_attributes": [
        {
          "attribute_path": "appointment.start_time"
        }
      ]
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.