Skip to main content
POST
Create webhook subscription

Headers

x-api-key
any
required

Api key required to authenticate your request. Please reach out to monument for a key.

Example:

"monument-2230012-2312321"

Path Parameters

Body

application/json
targetUrl
string
required

Target webhook URL (HTTPS only; no localhost, loopback, or private IPs). A query string is allowed and can be used to disambiguate the same base URL across multiple portfolios — Svix treats distinct query strings as distinct endpoints.

Example:

"https://vendor.example.com/webhooks/monument"

eventTypes
string[]
required

Array of event types to subscribe to

Example:
description
string
required

Description of the webhook subscription

Example:

"webhook"

portfolio
string
required

Database prefix (portfolio)

Example:

""

facilityUuids
string[]

Facility UUIDs

Example:
amenityUuids
string[]

Amenity UUIDs

Example:
unitTypes
string[]

Unit type UUIDs

Example:

Response

Successfully created webhook subscription

applicationId
string
required

Svix application ID

Example:

"app_1234567890"

url
string
required

Webhook URL

Example:

"https://vendor.example.com/webhooks/monument"

subscribedEventTypes
string[]
required

Subscribed event types

Example:
facilityUuids
string[]
required

Facility UUIDs

Example:
amenityUuids
string[]
required

Amenity UUIDs

Example:
unitTypes
string[]
required

Unit type UUIDs

Example:
databasePrefix
string
required

Database prefix

Example:

""

secret
string
required

Endpoint secret

Example:

"****"