Skip to main content
POST
/
api
/
v1
/
webhooks
/
subscriptions
/
test
Send test event
curl --request POST \
  --url https://public-api.prd.monument.io/api/v1/webhooks/subscriptions/test \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "eventType": "moved-in",
  "portfolio": "portfolio-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

Body

application/json
​
eventType
string
required

Event type

Example:

"moved-in"

​
portfolio
string
required

Portfolio (database prefix) so the test message is delivered to the correct endpoint via channels

Example:

"portfolio-prefix"

Response

Successfully sent test event