Skip to main content
Webhooks let you push data out of LeadScout the moment something happens — a prospect’s status changes, an appointment is created, a knock is logged. Instead of polling the API, LeadScout sends an HTTP POST request to a URL you control. Use webhooks to keep a CRM updated, trigger custom workflows, write to a database, or notify other internal tools without any manual export step.
Creating and managing webhooks requires the admin role. Team members with other roles can see the LeadScout data that webhooks deliver to your external systems, but they cannot register or modify webhooks.

Register a webhook

1

Open Webhooks settings

Go to Settings → Integrations → Webhooks and click Add Webhook.
2

Fill in the webhook details

Provide the following:
3

Add event registrations

After saving the webhook, add one or more event registrations. Each registration tells LeadScout which event type to listen for and how to deliver it.
4

Save and test

Save your registrations. LeadScout begins delivering payloads for any matching events immediately.

Event registrations

Each webhook can subscribe to multiple events. When you add an event registration, you configure:

Available event types

The event field accepts any string your system defines. Common events used with LeadScout include prospect lifecycle events (such as status changes), appointment events (created, updated, canceled), and knock events (logged). Use the event name that matches what your external system expects to receive.
Each webhook can only register a given event type once. If you need to send the same event to two different URLs, create two separate webhooks.

Verifying webhook signatures

Every payload LeadScout sends includes a signature so you can confirm it came from LeadScout and has not been tampered with. The signature is an HMAC of the payload computed using your webhook’s secret key and is sent in the X-LeadScout-Signature header. To verify a payload on your server:
1

Read the signature header

Read the X-LeadScout-Signature header value from the incoming request.
2

Compute the expected HMAC

Use your webhook’s secret key and the raw request body to compute an HMAC-SHA256 digest. Compare it to the value from the header.
3

Reject mismatches

If the signatures do not match, discard the request — it was not sent by LeadScout or was modified in transit.
Store your secret key securely — treat it like a password. If you suspect it has been compromised, delete the webhook and create a new one with a fresh secret.

Example webhook payload

LeadScout sends a POST request with a JSON body. The data field contains the full record for the entity that triggered the event.
example payload

Viewing delivery logs

LeadScout keeps a log of every event delivery attempt for each webhook. Go to Settings → Integrations → Webhooks, click a webhook, then open Logs to see:
  • Delivery timestamp
  • HTTP status code returned by your endpoint
  • The payload that was sent
  • The response your server returned
Logs are paginated and show the 50 most recent deliveries by default.

Edit or delete a webhook

To update a webhook’s name or URL, go to Settings → Integrations → Webhooks, click the webhook, and save your changes. To remove a webhook entirely, click Delete — this permanently stops all future deliveries for that webhook and its registrations.