curl --request POST \
--url 'https://api.scanova.io/webhook/' \
--header 'Authorization: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"type": "lead",
"urls": ["https://example.com/hooks/lead-capture"],
"lead_list": 12,
"comment": "CRM sync"
}'
{
"id": 44,
"lead_list": 12,
"form": null,
"qr_code": null,
"hubspot_connection": null,
"tracking_id": null,
"type": "lead",
"url": "https://example.com/hooks/lead-capture",
"is_active": true,
"redirection_delay": null,
"status": "active",
"event_type": null,
"last_used_on": null,
"last_used_status": null,
"comment": "CRM sync",
"misc": null,
"created": "2026-09-09T08:00:00+05:30",
"created_by_name": "Jane Doe",
"modified": "2026-09-09T08:00:00+05:30",
"lead_list_name": "Storefront Leads",
"form_name": null,
"form_form_id": null,
"qr_qrid": null,
"sub_type": "lead"
}
Integrations
List / create webhooks
GET, POST /webhook/
GET
/
webhook
/
curl --request POST \
--url 'https://api.scanova.io/webhook/' \
--header 'Authorization: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"type": "lead",
"urls": ["https://example.com/hooks/lead-capture"],
"lead_list": 12,
"comment": "CRM sync"
}'
{
"id": 44,
"lead_list": 12,
"form": null,
"qr_code": null,
"hubspot_connection": null,
"tracking_id": null,
"type": "lead",
"url": "https://example.com/hooks/lead-capture",
"is_active": true,
"redirection_delay": null,
"status": "active",
"event_type": null,
"last_used_on": null,
"last_used_status": null,
"comment": "CRM sync",
"misc": null,
"created": "2026-09-09T08:00:00+05:30",
"created_by_name": "Jane Doe",
"modified": "2026-09-09T08:00:00+05:30",
"lead_list_name": "Storefront Leads",
"form_name": null,
"form_form_id": null,
"qr_qrid": null,
"sub_type": "lead"
}
A webhook here is a generic connection row covering every integration type — plain URL-based webhooks, Zapier, and (once connected via the web app) Slack/HubSpot connections too. This lists or creates them.
Requires the
IntegrationCanView (GET) or IntegrationCanAdd (POST) permission, which itself checks the quota named by the target type (see List integration types).string
Matches against the URL, tracking id, comment/connection name, and linked lead-list/form name.
string
One of
created, modified, last_used_on. Prefix with - to sort descending.string
required
Integration type key, e.g.
lead, form, analytics, event_tracking, zapier. See List integration types for the full set and each type’s required fields.array
One or more target URLs. When more than one is sent on create, one webhook row is created per URL (bulk-created, only the first is returned in the response).
integer
Lead list id, for lead-notification webhook types.
integer
Form id, for form-notification webhook types.
string
Free-text label — also doubles as the searchable “connection name” for types with no other distinguishing field.
boolean
Whether the webhook is currently enabled.
curl --request POST \
--url 'https://api.scanova.io/webhook/' \
--header 'Authorization: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"type": "lead",
"urls": ["https://example.com/hooks/lead-capture"],
"lead_list": 12,
"comment": "CRM sync"
}'
{
"id": 44,
"lead_list": 12,
"form": null,
"qr_code": null,
"hubspot_connection": null,
"tracking_id": null,
"type": "lead",
"url": "https://example.com/hooks/lead-capture",
"is_active": true,
"redirection_delay": null,
"status": "active",
"event_type": null,
"last_used_on": null,
"last_used_status": null,
"comment": "CRM sync",
"misc": null,
"created": "2026-09-09T08:00:00+05:30",
"created_by_name": "Jane Doe",
"modified": "2026-09-09T08:00:00+05:30",
"lead_list_name": "Storefront Leads",
"form_name": null,
"form_form_id": null,
"qr_qrid": null,
"sub_type": "lead"
}
secret_key is write-only on the model but not in WebhookSerializer’s field list output — never rely on reading it back; store it client-side at creation time if the integration type needs one.Related
- Retrieve / update / delete a webhook
- List integration types — required fields and quota per
type. - Test a webhook
- Management API overview — the auth scheme and quota architecture this endpoint is part of.
Authorizations
Send your Management API key as the raw value of the Authorization header — no "Bearer " or "Token " prefix, and no other characters. Example: Authorization: 401f7ac837da42b97f613d789819ff93537bee6a. A header containing more than one space-separated part is rejected outright. Requests also require the request's Host header to be the management API host (e.g. api.scanova.io) — the same key sent to the regular API host will not authenticate.
Response
200 - application/json
Paginated list of webhooks.
Was this page helpful?