Skip to main content
DELETE
/
api
/
v1
/
webhooks
/
subscriptions
Unsubscribe from webhook
curl --request DELETE \
  --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",
  "portfolio": "",
  "eventTypes": [
    "moved-in",
    "moved-out"
  ]
}
'
{
  "applicationId": "app_1234567890",
  "vendorName": "example-vendor",
  "endpointId": "ep_1234567890",
  "url": "https://vendor.example.com/webhooks/monument",
  "unsubscribedEventTypes": [
    "moved-out"
  ],
  "remainingEventTypes": [
    "moved-in"
  ]
}

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"

​
portfolio
string
required

Database prefix (portfolio)

Example:

""

​
eventTypes
string[]
required

Array of event types to unsubscribe from

Example:
["moved-in", "moved-out"]

Response

Successfully unsubscribed from webhook

​
applicationId
string
required

Svix application ID

Example:

"app_1234567890"

​
vendorName
string
required

Vendor name

Example:

"example-vendor"

​
endpointId
string
required

Svix endpoint ID

Example:

"ep_1234567890"

​
url
string
required

Webhook URL

Example:

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

​
unsubscribedEventTypes
string[]

Unsubscribed event types (only when partial unsubscribe)

Example:
["moved-out"]
​
remainingEventTypes
string[]

Remaining event types (only when partial unsubscribe)

Example:
["moved-in"]