New to VisionScaper?
Start here
Help Center › Get your API keys › Use VisionScaper with Zapier
Use VisionScaper with Zapier
Use Webhooks by Zapier with your access key to react to VisionScaper events or add leads and customers.
Once you have an access key, Zapier can do two things. It can react when something happens in VisionScaper, or it can add leads and customers to VisionScaper.
Note: Zapier’s own help pages could not be opened here, so Zapier’s screen names below come from VisionScaper’s built-in guide and Zapier’s product page. Exact Zapier labels are unverified.
Before you start
- A VisionScaper access key with Set up alerts (needed by Zapier) ticked (see “Make a VisionScaper access key for Zapier”).
- The three addresses from Settings → Connect other tools → Zapier: Subscribe address, Unsubscribe address, and Sample address. Each has a copy box. The tab How it works shows the Starting address.
Events you can use
| Event | When it fires | Key needs |
|---|---|---|
lead.created |
A new lead comes in | Look at customers and leads |
customer.created |
A customer is added | Look at customers and leads |
quote.sent |
A quote is sent | Look at quotes |
quote.accepted |
A quote is accepted (signed) | Look at quotes |
job.completed |
A job is marked done | Look at jobs |
invoice.paid |
An invoice is paid | Look at invoices |
Steps: react to VisionScaper
- In Zapier add a step using Webhooks by Zapier (or a private Zapier app) and choose Custom Request, as VisionScaper’s guide says.
- Send a POST to the Subscribe address.
- Add a header named
Authorizationwith the valueBearerthen your key (the word Bearer, a space, the key). - In the body, send an
event(one of the names above) and the address Zapier gave you for that trigger, astarget_url(hookUrlalso works). Keep the body JSON. - VisionScaper answers with an id. Keep it for the unsubscribe step.
- When the Zap is turned off, send a POST to the Unsubscribe address with the same header and the
id. - To test before real data exists, GET the Sample address followed by the event name (for example
lead.created). It lists your newest real records, or one marked example.
Steps: add a lead or customer
- Use a Custom Request with a POST to the leads or customers address shown on the How it works tab.
- Add the same
Authorization: Bearer <key>header and send JSON. - A person with the same email or phone is never added twice. VisionScaper tells you who already exists. Add an
Idempotency-Keyheader so a retry does not duplicate.
Things to know
- VisionScaper retries a failed alert after 1 minute, 5 minutes, 30 minutes, 2 hours and 6 hours, then gives up. After 10 failures in a row the alert is switched off and you are emailed.
- Zapier’s Zap-off signal (a 410 answer) removes the subscription.
- Over the hourly limit you get 429 with a Retry-After header. If the plan has none, you get 402. The limit is a placeholder, not approved.
- Alerts are signed with
X-VisionScaper-Signature: t=<time>,v1=<code>. The code is HMAC-SHA256 of<time>.<body>using the alert’s signing secret.
If something goes wrong
- 404 invalid_event. The event name has a typo.
- 403 insufficient_scope. Tick the matching “Look at” box on the key.
- Nothing fires. Check that the subscription shows under Alerts to other tools with “From Zapier” and “On”.
Sources
- Plugin: assets/js/api-platform.js; includes/modules/api-platform.php (routes zap/subscribe, zap/unsubscribe, zap/poll).
- Zapier, Webhooks by Zapier: https://zapier.com/apps/webhook/integrations (read 2026-10-15)