Subscribe (create) a webhook

curl --request POST \
  --url https://anzapi.onboardme.app/api/v1/webhooks \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "hookUrl": "<string>",
  "targetUrl": "<string>",
  "webhookEvent": "<string>",
  "webhookName": "<string>",
  "webhookSecret": "<string>"
}
'

import requests

url = "https://anzapi.onboardme.app/api/v1/webhooks"

payload = {
    "hookUrl": "<string>",
    "targetUrl": "<string>",
    "webhookEvent": "<string>",
    "webhookName": "<string>",
    "webhookSecret": "<string>"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    hookUrl: '<string>',
    targetUrl: '<string>',
    webhookEvent: '<string>',
    webhookName: '<string>',
    webhookSecret: '<string>'
  })
};

fetch('https://anzapi.onboardme.app/api/v1/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://anzapi.onboardme.app/api/v1/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([
    'hookUrl' => '<string>',
    'targetUrl' => '<string>',
    'webhookEvent' => '<string>',
    'webhookName' => '<string>',
    'webhookSecret' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$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://anzapi.onboardme.app/api/v1/webhooks"

	payload := strings.NewReader("{\n  \"hookUrl\": \"<string>\",\n  \"targetUrl\": \"<string>\",\n  \"webhookEvent\": \"<string>\",\n  \"webhookName\": \"<string>\",\n  \"webhookSecret\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "Basic <encoded-value>")
	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://anzapi.onboardme.app/api/v1/webhooks")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"hookUrl\": \"<string>\",\n  \"targetUrl\": \"<string>\",\n  \"webhookEvent\": \"<string>\",\n  \"webhookName\": \"<string>\",\n  \"webhookSecret\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://anzapi.onboardme.app/api/v1/webhooks")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"hookUrl\": \"<string>\",\n  \"targetUrl\": \"<string>\",\n  \"webhookEvent\": \"<string>\",\n  \"webhookName\": \"<string>\",\n  \"webhookSecret\": \"<string>\"\n}"

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

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

Webhooks

Subscribe a webhook

Creates an outbound webhook subscription (for example a Zapier REST hook target URL). Supported webhookEvent values are listed at GET /api/v1/webhooks/events (e.g. proposal.accepted, eform.submitted). One subscription row per event; use the same URL twice for multiple events. Request accepts either hookUrl or Zapier’s targetUrl.

Outbound deliveries include:

X-Om-Event
X-Om-Event-Id
X-Om-Timestamp
X-Om-Signature (sha256=<hex>) on every delivery using the webhookSecret returned at subscribe.

Signature canonical string format: X-Om-Timestamp + "." + rawRequestBody signed with HMAC SHA256 using your webhookSecret.

Returns id and webhookSecret for use with DELETE /api/v1/webhooks/{id} when unsubscribing. The signing secret is shown once at creation; store it to verify X-Om-Signature on deliveries. A server-generated secret is always created (any webhookSecret in the request body is ignored).

401: Invalid credentials.

403: API client does not have write access.

429: Rate limit exceeded.

POST

api

webhooks

Subscribe (create) a webhook

curl --request POST \
  --url https://anzapi.onboardme.app/api/v1/webhooks \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "hookUrl": "<string>",
  "targetUrl": "<string>",
  "webhookEvent": "<string>",
  "webhookName": "<string>",
  "webhookSecret": "<string>"
}
'

import requests

url = "https://anzapi.onboardme.app/api/v1/webhooks"

payload = {
    "hookUrl": "<string>",
    "targetUrl": "<string>",
    "webhookEvent": "<string>",
    "webhookName": "<string>",
    "webhookSecret": "<string>"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    hookUrl: '<string>',
    targetUrl: '<string>',
    webhookEvent: '<string>',
    webhookName: '<string>',
    webhookSecret: '<string>'
  })
};

fetch('https://anzapi.onboardme.app/api/v1/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://anzapi.onboardme.app/api/v1/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([
    'hookUrl' => '<string>',
    'targetUrl' => '<string>',
    'webhookEvent' => '<string>',
    'webhookName' => '<string>',
    'webhookSecret' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$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://anzapi.onboardme.app/api/v1/webhooks"

	payload := strings.NewReader("{\n  \"hookUrl\": \"<string>\",\n  \"targetUrl\": \"<string>\",\n  \"webhookEvent\": \"<string>\",\n  \"webhookName\": \"<string>\",\n  \"webhookSecret\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "Basic <encoded-value>")
	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://anzapi.onboardme.app/api/v1/webhooks")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"hookUrl\": \"<string>\",\n  \"targetUrl\": \"<string>\",\n  \"webhookEvent\": \"<string>\",\n  \"webhookName\": \"<string>\",\n  \"webhookSecret\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://anzapi.onboardme.app/api/v1/webhooks")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"hookUrl\": \"<string>\",\n  \"targetUrl\": \"<string>\",\n  \"webhookEvent\": \"<string>\",\n  \"webhookName\": \"<string>\",\n  \"webhookSecret\": \"<string>\"\n}"

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

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

Authorizations

Authorization

string

header

required

Swagger / Postman only: Client ID as username, Client secret as password. In Postman, set this once on the collection (Authorization → Basic Auth) so all requests inherit. For production server-to-server code, prefer X-OM-Auth-ID and X-OM-Auth-Key headers.

Body

hookUrl

string | null

targetUrl

string | null

webhookEvent

string | null

webhookName

string | null

webhookSecret

string | null

Response

Created

API documentation

Endpoints

Building blocks

Subscribe a webhook

Authorizations

Body

Response