Skip to main content
POST
Create 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.

Headers

Idempotency-Key
string

Optional idempotency key, scoped to the authenticated account. Repeating a write with the same key + same body returns the original response; same key + different body returns 422 idempotency_key_in_use.

Maximum string length: 255

Body

application/json
name
string
required

Display label shown in Settings → Developers + on delivery logs.

Required string length: 1 - 100
url
string<uri>
required

HTTPS endpoint to POST events to. HTTP allowed only for localhost URLs in development.

events
string[]

Subset of event types to subscribe to. Omit or pass [] to subscribe to all event types — useful for a generic ingest endpoint.

Response

Endpoint created. Response includes the signingSecret exactly once.

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
signingSecret
string
required

Secret used to verify webhook signatures (HMAC-SHA256, Stripe pattern). Shown exactly once at creation — store it now. Rotate by deleting + recreating the endpoint.