Skip to main content
GET
Fetch a webhook endpoint

Authorizations

Authorization
string
header
required

Bearer API key. Two modes: sv_live_* for production data, sv_test_* for a parallel sandbox dataset that doesn't count against plan limits. Issued from Settings → Developers in the SiteVisit app.

Path Parameters

id
string
required

Response

The requested resource.

id
string
required
name
string
required
url
string<uri>
required
events
string[]
required

Events this endpoint subscribes to. An empty array means all events — the endpoint will receive every event type. See the Webhooks guide for the full event catalogue.

mode
enum<string>
required

Which traffic class this endpoint receives. live endpoints fire on real customer activity; test endpoints only fire on activity triggered by sv_test_* API keys. Lets integrators wire a localhost endpoint against test mode without it ever receiving real-customer traffic.

Available options:
live,
test
disabled
boolean
required

When true, the endpoint is paused — events are not delivered, but the row + signing secret remain so it can be re-enabled later.

createdAt
string<date-time>
required
updatedAt
string<date-time>
required