Configuring the webhook

POST /companies/{company_id}/webhooks

Creates the webhook, or replaces the existing one. Saving also clears the consecutive-failure counter, so this is how you re-enable a webhook that was switched off.

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

Path parameters

string

required

The location.

Body

string

required

A valid, publicly reachable URL.

string

required

POST, PUT, PATCH or GET. With GET the event is sent as query parameters instead of a body.

boolean

default:"false"

Set true to start delivering.

string

Sent as HTTP Basic credentials together with auth_password.

string

The matching password.

Response

string

Webhook configured successfully

string

The webhook id.

curl -X POST https://api.vizito.eu/api/companies/5f2a1b9c4d3e2f0011223344/webhooks \
  -H "Authorization: Bearer $VIZITO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com/hooks/vizito",
    "http_method": "POST",
    "auth_username": "vizito",
    "auth_password": "a-shared-secret",
    "enabled": true
  }'

{ "message": "Webhook configured successfully", "webhook_id": "66c2b3c4d5e6f70011223344" }

Status	Body	Meaning
`400`	`{ "error": "Invalid HTTP method" }`	`http_method` outside the four allowed values
`400`	`{ "error": "URL is required and must be a non-empty string" }`	Missing URL
`400`	`{ "error": "Invalid URL format" }`	Unparseable URL

Events you will receive

Event	Extra fields
`visitor_signed_in`	`visitorId`, `visitTypeId`, `knownVisitorId`
`visitor_signed_out`	`visitorId`, `visitTypeId`, `knownVisitorId`
`visitor_updated`	`visitorId`, `visitTypeId`, `knownVisitorId`
`visitor_screening_approved`	`visitorId`, `knownVisitorId`, `approvalStatus`
`visitor_screening_rejected`	`visitorId`, `knownVisitorId`, `approvalStatus`
`registered_visitor_created`	`knownVisitorId`, `visitTypeId`
`registered_visitor_updated`	`knownVisitorId`, `visitTypeId`
`registered_visitor_deleted`	`knownVisitorId`, `visitTypeId`
`registered_visitor_preregistered`	`knownVisitorId`
`device_added`	`deviceUuid`
`device_online`	`deviceUuid`
`device_offline`	`deviceUuid`
`device_deleted`	`deviceUuid`
`company_updated`	—

Every payload also carries eventName and companyId.

Webhooks guide

Payloads, auto-disabling after five failures, and what to do about missed events.

Getting started

Locations

Visitors

Registered visitors

Hosts

Visit types

Entry points

Agreements

Devices

Reporting

Webhooks

Configuring the webhook

Path parameters

Body

Response

Events you will receive

Webhooks guide

​Path parameters

​Body

​Response

​Events you will receive

Webhooks guide

Path parameters

Body

Response

Events you will receive