webhook

Send a mock insurance ref-data webhook

Sandbox only. Sends one signed sample insurance reference-data notification to the webhook_url you supply, signed with the webhook_key you supply, and returns the notification it sent. Verify the signature against the raw bytes your endpoint received, not against this response: its key order and null fields can differ from the signed body.

Use it to verify your signature check and your parsing of changed_entities before Zocdoc starts delivering real notifications. The sample carries fixed sandbox plan and carrier ids and a fixed event_id; only event_time_utc varies per call.

Pass event_type to choose which notification to receive. It defaults to insurance_plans_updated.

A 200 means Zocdoc sent the request, not that your endpoint accepted it. Whatever status your endpoint returns is not reflected here — check your own logs for how it handled the delivery.

post/v1/webhook/insurance-ref-data/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 public https url to receive the mock webhook request. Redirects are not followed.

webhook_keystring required

a valid key for the signature in base64 format

event_type'insurance_plans_updated' | 'insurance_carriers_updated'

Which insurance reference-data entity changed. Every entry in changed_entities on a notification shares the notification's type.

Response

The notification that was sent.

event_idstring required

Correlation id for this delivery, format evt_<32 hex characters>. Useful when reporting a delivery to Zocdoc support. Not a dedup key — it is derived from the event type, your client, and the set of entities in the delivery, so a redelivery that batches the entities differently carries a different id, and two integrations receiving the same change see different ids. Dedup by entity id instead.

event_type'insurance_plans_updated' | 'insurance_carriers_updated' required

Which insurance reference-data entity changed. Every entry in changed_entities on a notification shares the notification's type.

event_time_utcstring instant required

When Zocdoc emitted the notification, in UTC.

Example response

{
  "event_id": "evt_4f2c8a91d0b34e6f8a1c7d5e9b0f2a63",
  "changed_entities": [
    {
      "insurance_plan_id": "ip_5432",
      "insurance_carrier_id": "ic_440",
      "changed_attributes": [
        {
          "attribute_path": "insurance_plan.name"
        }
      ]
    }
  ]
}

Changes

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