Skip to main content
POST
/
api
/
v1
/
webhooks
/
subscriptions
Create webhook subscription
curl --request POST \
  --url https://public-api.prd.monument.io/api/v1/webhooks/subscriptions \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "vendorName": "example-vendor",
  "targetUrl": "https://vendor.example.com/webhooks/monument",
  "eventTypes": [
    "moved-in",
    "moved_out"
  ],
  "description": "webhook",
  "portfolio": "",
  "facilityUuids": [],
  "amenityUuids": [],
  "unitTypes": []
}
'
{
  "endpointId": "ep_1234567890",
  "applicationId": "app_1234567890",
  "url": "https://vendor.example.com/webhooks/monument",
  "subscribedEventTypes": [
    "move_in",
    "move_out"
  ],
  "facilityUuids": [],
  "amenityUuids": [],
  "unitTypes": [],
  "databasePrefix": "",
  "secret": "****"
}

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
​
vendorName
string
required

Vendor name

Example:

"example-vendor"

​
targetUrl
string
required

Target webhook URL (HTTPS only, no localhost, loopback, or private IPs, no query string)

Example:

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

​
eventTypes
string[]
required

Array of event types to subscribe to

Example:
["moved-in", "moved_out"]
​
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

​
endpointId
string
required

Svix endpoint ID

Example:

"ep_1234567890"

​
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:
["move_in", "move_out"]
​
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:

"****"