POST
/
{apiVersion}
/
{apiProvince}
/
webhooks
curl --request POST \
  --url https://api.getbuildify.com/{apiVersion}/{apiProvince}/webhooks \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "env": "test",
  "targetUrl": "<string>",
  "event": "<string>"
}'
"{}"

Authorizations

x-api-key
string
header
required

Path Parameters

apiVersion
enum<string>
required
Available options:
v1-sandbox,
v1-lite,
v1
apiProvince
enum<string>
default:
on
required
Available options:
on,
bc,
ab,
mb,
nb,
nl,
ns,
pe,
qc,
sk

Body

application/json
env
string
default:
test
required

Either test or live

targetUrl
string
required

Valid https url

event
string
required

Only possible values are: LISTINGS.CREATED, LISTING.UPDATED, LISTING.DELETED, PROFILE.CREATED, PROFILE.UPDATED, PROFILE.DELETED

Response

200
application/json
200

The response is of type object.