Fetching the webhook

GET /companies/{company_id}/webhooks

The webhook configured for the location. One webhook per location.

Webhooks are part of the Enterprise plan. On Standard and Pro this endpoint answers 404.

Path parameters

string

required

The location.

Response

string

The webhook id.

string

The location.

string

Endpoint Vizito calls.

string

POST, PUT, PATCH or GET.

boolean

Whether events are being delivered.

string

Basic auth username sent with each call.

string

Basic auth password sent with each call.

curl https://api.vizito.eu/api/companies/5f2a1b9c4d3e2f0011223344/webhooks \
  -H "Authorization: Bearer $VIZITO_API_KEY"

{
  "_id": "66c2b3c4d5e6f70011223344",
  "company_id": "5f2a1b9c4d3e2f0011223344",
  "url": "https://example.com/hooks/vizito",
  "http_method": "POST",
  "enabled": true,
  "auth_username": "vizito"
}

An empty object {} means no webhook is configured — or that yours was auto-disabled after five consecutive delivery failures. That makes this the quickest health check for your integration.

Getting started

Locations

Visitors

Registered visitors

Hosts

Visit types

Entry points

Agreements

Devices

Reporting

Webhooks

Fetching the webhook

Path parameters

Response

​Path parameters

​Response

Path parameters

Response