Create a subscription

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>"
}
'

import requests

url = "https://api.getbuildify.com/{apiVersion}/{apiProvince}/webhooks"

payload = {
    "env": "test",
    "targetUrl": "<string>",
    "event": "<string>"
}
headers = {
    "x-api-key": "<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': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({env: 'test', targetUrl: '<string>', event: '<string>'})
};

fetch('https://api.getbuildify.com/{apiVersion}/{apiProvince}/webhooks', 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://api.getbuildify.com/{apiVersion}/{apiProvince}/webhooks",
  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([
    'env' => 'test',
    'targetUrl' => '<string>',
    'event' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <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://api.getbuildify.com/{apiVersion}/{apiProvince}/webhooks"

	payload := strings.NewReader("{\n  \"env\": \"test\",\n  \"targetUrl\": \"<string>\",\n  \"event\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<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://api.getbuildify.com/{apiVersion}/{apiProvince}/webhooks")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"env\": \"test\",\n  \"targetUrl\": \"<string>\",\n  \"event\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getbuildify.com/{apiVersion}/{apiProvince}/webhooks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"env\": \"test\",\n  \"targetUrl\": \"<string>\",\n  \"event\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

"{}"

"{}"

POST

{apiVersion}

{apiProvince}

webhooks

Create a subscription

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>"
}
'

import requests

url = "https://api.getbuildify.com/{apiVersion}/{apiProvince}/webhooks"

payload = {
    "env": "test",
    "targetUrl": "<string>",
    "event": "<string>"
}
headers = {
    "x-api-key": "<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': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({env: 'test', targetUrl: '<string>', event: '<string>'})
};

fetch('https://api.getbuildify.com/{apiVersion}/{apiProvince}/webhooks', 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://api.getbuildify.com/{apiVersion}/{apiProvince}/webhooks",
  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([
    'env' => 'test',
    'targetUrl' => '<string>',
    'event' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <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://api.getbuildify.com/{apiVersion}/{apiProvince}/webhooks"

	payload := strings.NewReader("{\n  \"env\": \"test\",\n  \"targetUrl\": \"<string>\",\n  \"event\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<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://api.getbuildify.com/{apiVersion}/{apiProvince}/webhooks")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"env\": \"test\",\n  \"targetUrl\": \"<string>\",\n  \"event\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getbuildify.com/{apiVersion}/{apiProvince}/webhooks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"env\": \"test\",\n  \"targetUrl\": \"<string>\",\n  \"event\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

"{}"

"{}"

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:

all,

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

The response is of type object.