Skip to main content
PATCH
Update 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

Query Parameters

targetUrl
string
required
portfolio
string
required

Body

application/json
eventTypes
string[]

Array of event types to subscribe to

Example:
description
string

Description of the webhook subscription

Example:

"webhook"

facilityUuids
string[]

Facility UUIDs

Example:
amenityUuids
string[]

Amenity UUIDs

Example:
unitTypes
string[]

Unit type UUIDs

Example:

Response

Successfully updated 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:

""