Skip to content
KynectLocal Docs

Webhooks

For Developers

Webhooks allow your application to receive real-time notifications when events occur in KynectLocal — such as a new lead submission, a location profile update, or a governance enforcement event — without polling the API.

How webhooks will work

Section titled “How webhooks will work”

When a webhook is configured, KynectLocal will send an HTTP POST request to your endpoint URL each time a subscribed event occurs. Your endpoint must return a 2xx status code to acknowledge receipt.

Planned event types

Section titled “Planned event types”

The following event categories are planned for the webhook system:

CategoryEvents
Leadslead.created — a new form submission was captured at a location
Locationslocation.updated — a location profile was changed
Governancegovernance.blocked — a franchisee write was blocked by a governance rule
Contentcontent.updated — a page or template was updated
Usersuser.invited, user.role_changed

Planned request format

Section titled “Planned request format”

Each webhook delivery will be an HTTP POST with a JSON body:

{
  "event": "lead.created",
  "timestamp": "2025-01-15T14:32:00Z",
  "brand_id": "brand_abc123",
  "data": {
    "lead_id": "lead_xyz789",
    "location_id": "loc_def456",
    "form": "Contact Us",
    "source": "organic"
  }
}

Planned security

Section titled “Planned security”

Webhook payloads will include a signature header (X-KynectLocal-Signature) you can use to verify the request came from KynectLocal. Verification will use HMAC-SHA256 with a secret key you configure when registering the endpoint.

Current alternative

Section titled “Current alternative”

Until webhooks are available, you can poll the Locations API to detect changes, or use the Leads page in the admin to monitor form submissions.

If your integration requires real-time events, contact your KynectLocal account team to discuss your use case and get notified when webhooks are released.

Section titled “Related”