VeraDial Zapier Integration API Reference
VeraDial's Zapier integration uses REST Hooks to send receptionist events to a Zap as they happen. This reference covers the complete integration-facing API. The native Zapier app handles these requests for customers; direct callers should preserve the same contracts.
By Graham Thomson · Updated July 20, 2026
Base URL and authentication
The base URL is https://api.veradial.com/api/v1/integrations/zapier. Zapier-facing requests authenticate with Authorization: Bearer vdk_... using an API key generated from the VeraDial Integrations dashboard. The key is a narrow credential: it works only with the hooks, samples, and me endpoints described below, and its full value is shown once.
- Generate or revoke keys at https://app.veradial.com/dashboard/integrations. VeraDial Plus is required to create a key and subscribe a Zap.
- GET /me tests the API key and returns { id, name } for the connected VeraDial account.
- A revoked key returns 401 and immediately deactivates every REST Hook subscription created with that key.
- Never put an API key in a query string, webhook URL, log, or client-side bundle.
API-key management endpoints
Key management uses the customer's normal VeraDial session bearer token, not a vdk_ Zapier API key. The dashboard is the recommended client. These routes stay available for listing and revocation even when new Zapier connections are temporarily disabled.
- GET /keys returns { enabled, entitled, keys }. Each key record contains display metadata and status, never the secret value.
- POST /keys with { "name": "Zapier" } creates a key and returns 201 { apiKey }. The apiKey value is shown only in this response. A user may have up to five active keys.
- DELETE /keys/:id revokes the key and returns 204. Revocation is idempotent from the customer's point of view and severs its linked subscriptions.
- Creation can return 403 INTEGRATIONS_NOT_ENTITLED or 409 API_KEY_LIMIT_REACHED.
Subscribe and unsubscribe REST Hooks
All hook routes use the vdk_ API key. Subscription URLs must be public HTTPS endpoints and pass VeraDial's server-side request-forgery checks. A VeraDial account may have up to 25 active Zapier hook subscriptions.
- POST /hooks with { "targetUrl": "https://hooks.zapier.com/...", "kind": "call.screened" } returns 201 { id }.
- Supported kind values are call.screened, voicemail.received, sms.reply_sent, and appointment.booked.
- Repeating the same user, kind, and targetUrl reactivates the existing subscription, transfers it to the presenting key, resets delivery health, and returns the same id.
- DELETE /hooks/:id returns 200 { id }. It is idempotent and remains available for Zapier teardown when new subscriptions are disabled.
- Subscription can return 403 INTEGRATIONS_NOT_ENTITLED, 409 ZAPIER_SUBSCRIPTION_LIMIT_REACHED, or 400 for an unsafe target URL.
Samples and authentication test
GET /samples?kind=... returns an array of up to three recent events of that exact kind, newest first. If the account has no matching event, it returns one deterministic synthetic sample. Samples and live deliveries use the same envelope renderer, so sample keys match live hook keys.
- GET /samples?kind=call.screened returns Screened Call samples.
- GET /samples?kind=voicemail.received returns Voicemail samples.
- GET /samples?kind=sms.reply_sent returns AI Text Reply samples.
- GET /samples?kind=appointment.booked returns Appointment Booked samples.
- GET /me returns { id, name } and is the connection-label authentication test used by Zapier.
Live event envelope
Every hook delivery is one JSON object with id, type, version, kind, source, occurredAt, account, line, and data. type is receptionist.event.recorded and version is 1. account contains id; line contains phoneNumber and label. The fields inside data depend on the event kind.
- call.screened data: callId, caller, reason, organization, callbackNumber, urgency, requestedAction, and summary.
- voicemail.received data: voicemailId, callId, caller, durationSeconds, and transcriptionStatus.
- sms.reply_sent data: draftId, conversationKey, customer, mode, and body.
- appointment.booked data: appointmentBookingId, callId, caller, callbackNumber, reason, startAt, and endAt.
- V1 does not send call transcripts, voicemail transcriptions, or audio recordings through Zapier.
Delivery, retries, and duplicates
Delivery is at least once. VeraDial retries non-successful deliveries, and Zapier does not deduplicate REST Hook deliveries. If a successful response is lost in transit, the same event can run a Zap more than once.
- Treat envelope id as a stable correlation key, not a promise that Zapier will deduplicate the event.
- If duplicate side effects matter, store processed ids in the destination workflow before performing the action.
- A 2xx response marks the delivery successful. Retryable failures use backoff.
- A 410 Gone response means the Zap no longer accepts the hook; VeraDial immediately deactivates the subscription and does not retry it.
- Zapier deliveries are not HMAC-signed because the target URL is a capability URL supplied by Zapier. Custom VeraDial webhooks use a separate signed-delivery contract.
FAQ
Can I use a VeraDial Zapier key with other API routes?
No. A vdk_ key is deliberately limited to VeraDial's Zapier hooks, samples, and account-test routes. It is not a general VeraDial API credential.
Does VeraDial guarantee exactly-once Zap delivery?
No. Delivery is at least once, so duplicates are possible. Use the envelope id as a correlation key and add destination-side idempotency when repeating an action would be harmful.
Why are transcripts not included?
The first Zapier release intentionally limits payloads to operational event fields such as summaries, caller details, message bodies, and appointment times. Call transcripts, voicemail transcriptions, and audio are outside the v1 data contract.
What happens when I revoke a key?
VeraDial deactivates every Zapier subscription linked to that key in the same transaction. Already-running network requests may finish, but queued and future attempts are stopped when the worker observes the revocation.
Hear Vera in action.
Play a short sample call, follow the transcript, and move into a personalized live demo when you're ready.