Create webhook subscription
Creates a webhook subscription for the provided application ID
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 '
{
"targetUrl": "https://vendor.example.com/webhooks/monument",
"eventTypes": [
"moved-in",
"moved_out"
],
"description": "webhook",
"portfolio": "",
"facilityUuids": [],
"amenityUuids": [],
"unitTypes": []
}
'import requests
url = "https://public-api.prd.monument.io/api/v1/webhooks/subscriptions"
payload = {
"targetUrl": "https://vendor.example.com/webhooks/monument",
"eventTypes": ["moved-in", "moved_out"],
"description": "webhook",
"portfolio": "",
"facilityUuids": [],
"amenityUuids": [],
"unitTypes": []
}
headers = {
"x-api-key": "<x-api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
targetUrl: 'https://vendor.example.com/webhooks/monument',
eventTypes: ['moved-in', 'moved_out'],
description: 'webhook',
portfolio: '',
facilityUuids: [],
amenityUuids: [],
unitTypes: []
})
};
fetch('https://public-api.prd.monument.io/api/v1/webhooks/subscriptions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://public-api.prd.monument.io/api/v1/webhooks/subscriptions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'targetUrl' => 'https://vendor.example.com/webhooks/monument',
'eventTypes' => [
'moved-in',
'moved_out'
],
'description' => 'webhook',
'portfolio' => '',
'facilityUuids' => [
],
'amenityUuids' => [
],
'unitTypes' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <x-api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://public-api.prd.monument.io/api/v1/webhooks/subscriptions"
payload := strings.NewReader("{\n \"targetUrl\": \"https://vendor.example.com/webhooks/monument\",\n \"eventTypes\": [\n \"moved-in\",\n \"moved_out\"\n ],\n \"description\": \"webhook\",\n \"portfolio\": \"\",\n \"facilityUuids\": [],\n \"amenityUuids\": [],\n \"unitTypes\": []\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<x-api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://public-api.prd.monument.io/api/v1/webhooks/subscriptions")
.header("x-api-key", "<x-api-key>")
.header("Content-Type", "application/json")
.body("{\n \"targetUrl\": \"https://vendor.example.com/webhooks/monument\",\n \"eventTypes\": [\n \"moved-in\",\n \"moved_out\"\n ],\n \"description\": \"webhook\",\n \"portfolio\": \"\",\n \"facilityUuids\": [],\n \"amenityUuids\": [],\n \"unitTypes\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://public-api.prd.monument.io/api/v1/webhooks/subscriptions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"targetUrl\": \"https://vendor.example.com/webhooks/monument\",\n \"eventTypes\": [\n \"moved-in\",\n \"moved_out\"\n ],\n \"description\": \"webhook\",\n \"portfolio\": \"\",\n \"facilityUuids\": [],\n \"amenityUuids\": [],\n \"unitTypes\": []\n}"
response = http.request(request)
puts response.read_body{
"applicationId": "app_1234567890",
"url": "https://vendor.example.com/webhooks/monument",
"subscribedEventTypes": [
"move_in",
"move_out"
],
"facilityUuids": [],
"amenityUuids": [],
"unitTypes": [],
"databasePrefix": "",
"secret": "****"
}Headers
Api key required to authenticate your request. Please reach out to monument for a key.
"monument-2230012-2312321"
Path Parameters
Body
Target webhook URL (HTTPS only; no localhost, loopback, or private IPs). A query string is allowed and can be used to disambiguate the same base URL across multiple portfolios — Svix treats distinct query strings as distinct endpoints.
"https://vendor.example.com/webhooks/monument"
Array of event types to subscribe to
["moved-in", "moved_out"]
Description of the webhook subscription
"webhook"
Database prefix (portfolio)
""
Facility UUIDs
[]
Amenity UUIDs
[]
Unit type UUIDs
[]
Response
Successfully created webhook subscription
Svix application ID
"app_1234567890"
Webhook URL
"https://vendor.example.com/webhooks/monument"
Subscribed event types
["move_in", "move_out"]
Facility UUIDs
[]
Amenity UUIDs
[]
Unit type UUIDs
[]
Database prefix
""
Endpoint secret
"****"
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 '
{
"targetUrl": "https://vendor.example.com/webhooks/monument",
"eventTypes": [
"moved-in",
"moved_out"
],
"description": "webhook",
"portfolio": "",
"facilityUuids": [],
"amenityUuids": [],
"unitTypes": []
}
'import requests
url = "https://public-api.prd.monument.io/api/v1/webhooks/subscriptions"
payload = {
"targetUrl": "https://vendor.example.com/webhooks/monument",
"eventTypes": ["moved-in", "moved_out"],
"description": "webhook",
"portfolio": "",
"facilityUuids": [],
"amenityUuids": [],
"unitTypes": []
}
headers = {
"x-api-key": "<x-api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
targetUrl: 'https://vendor.example.com/webhooks/monument',
eventTypes: ['moved-in', 'moved_out'],
description: 'webhook',
portfolio: '',
facilityUuids: [],
amenityUuids: [],
unitTypes: []
})
};
fetch('https://public-api.prd.monument.io/api/v1/webhooks/subscriptions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://public-api.prd.monument.io/api/v1/webhooks/subscriptions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'targetUrl' => 'https://vendor.example.com/webhooks/monument',
'eventTypes' => [
'moved-in',
'moved_out'
],
'description' => 'webhook',
'portfolio' => '',
'facilityUuids' => [
],
'amenityUuids' => [
],
'unitTypes' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <x-api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://public-api.prd.monument.io/api/v1/webhooks/subscriptions"
payload := strings.NewReader("{\n \"targetUrl\": \"https://vendor.example.com/webhooks/monument\",\n \"eventTypes\": [\n \"moved-in\",\n \"moved_out\"\n ],\n \"description\": \"webhook\",\n \"portfolio\": \"\",\n \"facilityUuids\": [],\n \"amenityUuids\": [],\n \"unitTypes\": []\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<x-api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://public-api.prd.monument.io/api/v1/webhooks/subscriptions")
.header("x-api-key", "<x-api-key>")
.header("Content-Type", "application/json")
.body("{\n \"targetUrl\": \"https://vendor.example.com/webhooks/monument\",\n \"eventTypes\": [\n \"moved-in\",\n \"moved_out\"\n ],\n \"description\": \"webhook\",\n \"portfolio\": \"\",\n \"facilityUuids\": [],\n \"amenityUuids\": [],\n \"unitTypes\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://public-api.prd.monument.io/api/v1/webhooks/subscriptions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"targetUrl\": \"https://vendor.example.com/webhooks/monument\",\n \"eventTypes\": [\n \"moved-in\",\n \"moved_out\"\n ],\n \"description\": \"webhook\",\n \"portfolio\": \"\",\n \"facilityUuids\": [],\n \"amenityUuids\": [],\n \"unitTypes\": []\n}"
response = http.request(request)
puts response.read_body{
"applicationId": "app_1234567890",
"url": "https://vendor.example.com/webhooks/monument",
"subscribedEventTypes": [
"move_in",
"move_out"
],
"facilityUuids": [],
"amenityUuids": [],
"unitTypes": [],
"databasePrefix": "",
"secret": "****"
}
