Skip to main content
GET
/
api
/
v1
/
webhooks
/
subscriptions
Get webhook subscriptions
curl --request GET \
  --url https://public-api.prd.monument.io/api/v1/webhooks/subscriptions \
  --header 'x-api-key: <x-api-key>'
{
  "applicationId": "app_1234567890",
  "endpoints": [
    {
      "url": "https://vendor.example.com/webhooks/monument",
      "description": "webhook"
    }
  ],
  "items": [
    {
      "url": "https://vendor.example.com/webhooks/monument",
      "eventType": "move_in",
      "facilityUuids": [
        "11111111-1111-1111-1111-111111111111"
      ],
      "unitTypes": [
        "22222222-2222-2222-2222-222222222222"
      ],
      "amenityUuids": [
        "33333333-3333-3333-3333-333333333333"
      ],
      "portfolio": "test_prefix"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://api.monument.io/llms.txt

Use this file to discover all available pages before exploring further.

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
​
eventType
string
required
​
portfolio
string
required

Response

Successfully retrieved subscriptions

​
applicationId
string
required

Svix application ID

Example:

"app_1234567890"

​
endpoints
object[]
required

Endpoints visible to this caller. One entry per unique URL with the endpoint-level description.

​
items
object[]
required

Array of subscription items