Alerts (webhooks): setup and events

Help Center › API keys & connections › Alerts (webhooks): setup and events

Alerts (webhooks): setup and events

Add an alert address, choose events like lead.created or invoice.paid, and copy the signing secret.

An alert sends a short signed message to a web address when something happens in VisionScaper.

Before you start

  • A public https:// address that can receive POST requests (your own server, or a service such as Zapier).
  • Plan inclusion for Connect other tools.

Steps

  1. Open Settings → Zapier & API keys and the tab Alerts to other tools.
  2. In Add an alert, type the address into Send alerts to this address. It must start with https://, be under 500 characters, and be a public website.
  3. Under Tell it when…, tick the events you want.
  4. Press Add alert.
  5. Copy the signing secret from the box Copy the signing secret now. It starts with whsec_ and is shown only once.
  6. Press I have saved it.
  7. On the alert, press Send a test. The toast tells you whether the other side answered and with which code.

The events

Event Tick box wording When it fires
lead.created A new lead comes in As the lead arrives
customer.created A customer is added Found by the background check
quote.sent A quote is sent Found by the background check
quote.accepted A quote is accepted (signed) Found by the background check
job.completed A job is marked done Found by the background check
invoice.paid An invoice is paid Found by the background check

Lead alerts go out as the lead arrives. The others are found by a check that runs about every 5 minutes (and soon after a signed-in change), so they can be up to about 5 minutes late. Customers brought in by a bulk import or a sync are not announced.

What is sent

{ "id": "evt_123", "object": "event", "type": "invoice.paid",
  "created": "2026-01-05T14:00:00Z",
  "data": { "object": { "object": "invoice", "id": 7, "number": "...", "status": "paid", "amount": 0 } } }

The data.object is the same customer, quote, invoice or job shape the API returns.

Headers on each POST: Content-Type: application/json, User-Agent: VisionScaper-Webhooks/1, X-VisionScaper-Event, X-VisionScaper-Delivery, X-VisionScaper-Attempt and X-VisionScaper-Signature.

Managing alerts

Each alert row has Send a test, turn on or off, a log button, a new-secret button (the old secret stops working), and Remove. Limit: 25 alerts per business.

Tips

  • Answer with any 2xx status quickly. The timeout is about 8 seconds.
  • Each event is recorded once, so a re-check cannot send it twice. A quote sent again later can be a new event.
  • Local, private and unresolvable addresses are refused, and redirects are not followed.

If something goes wrong

  • “That address can’t be reached from the internet.” Use a public address.
  • “The address must start with https://”.
  • “Choose at least one thing to be told about.”
  • “You have 25 alerts set up.” Remove one first.

Related articles

Still need help?

Tell us what you were trying to do and a person will reply.

Contact support