curl --request POST \
--url https://v2.prod.halliday.xyz/orgs/webhooks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"url": "https://api.yourapp.com/halliday/webhooks",
"label": "prod-workflows",
"event_types": [
"WORKFLOW_COMPLETED",
"WORKFLOW_FAILED"
],
"auth_header": {
"name": "X-Webhook-Token",
"value": "a-shared-secret-token"
}
}
'import requests
url = "https://v2.prod.halliday.xyz/orgs/webhooks"
payload = {
"url": "https://api.yourapp.com/halliday/webhooks",
"label": "prod-workflows",
"event_types": ["WORKFLOW_COMPLETED", "WORKFLOW_FAILED"],
"auth_header": {
"name": "X-Webhook-Token",
"value": "a-shared-secret-token"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
url: 'https://api.yourapp.com/halliday/webhooks',
label: 'prod-workflows',
event_types: ['WORKFLOW_COMPLETED', 'WORKFLOW_FAILED'],
auth_header: {name: 'X-Webhook-Token', value: 'a-shared-secret-token'}
})
};
fetch('https://v2.prod.halliday.xyz/orgs/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://v2.prod.halliday.xyz/orgs/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([
'url' => 'https://api.yourapp.com/halliday/webhooks',
'label' => 'prod-workflows',
'event_types' => [
'WORKFLOW_COMPLETED',
'WORKFLOW_FAILED'
],
'auth_header' => [
'name' => 'X-Webhook-Token',
'value' => 'a-shared-secret-token'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://v2.prod.halliday.xyz/orgs/webhooks"
payload := strings.NewReader("{\n \"url\": \"https://api.yourapp.com/halliday/webhooks\",\n \"label\": \"prod-workflows\",\n \"event_types\": [\n \"WORKFLOW_COMPLETED\",\n \"WORKFLOW_FAILED\"\n ],\n \"auth_header\": {\n \"name\": \"X-Webhook-Token\",\n \"value\": \"a-shared-secret-token\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://v2.prod.halliday.xyz/orgs/webhooks")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"https://api.yourapp.com/halliday/webhooks\",\n \"label\": \"prod-workflows\",\n \"event_types\": [\n \"WORKFLOW_COMPLETED\",\n \"WORKFLOW_FAILED\"\n ],\n \"auth_header\": {\n \"name\": \"X-Webhook-Token\",\n \"value\": \"a-shared-secret-token\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://v2.prod.halliday.xyz/orgs/webhooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"https://api.yourapp.com/halliday/webhooks\",\n \"label\": \"prod-workflows\",\n \"event_types\": [\n \"WORKFLOW_COMPLETED\",\n \"WORKFLOW_FAILED\"\n ],\n \"auth_header\": {\n \"name\": \"X-Webhook-Token\",\n \"value\": \"a-shared-secret-token\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "4f2c…",
"label": "prod-workflows",
"url": "https://api.yourapp.com/halliday/webhooks",
"signing_secret": "a1b2c3…"
}{
"errors": [
{
"code": "invalid_type",
"expected": "string",
"path": [
"label"
],
"message": "Invalid input: expected string, received undefined"
}
]
}{
"errors": [
{
"kind": "other",
"message": "Invalid API key"
}
]
}{
"errors": [
{
"kind": "other",
"message": "Publishable keys cannot manage webhooks"
}
]
}Register a webhook
Register an HTTPS endpoint to receive signed event notifications when a workflow reaches a
terminal state. Halliday delivers each event as an HTTP POST to your registered url, so the
endpoint must accept POST requests. On success the response includes a signing_secret that
is only ever returned on creation and rotation — store it immediately, because it cannot be
retrieved again from the list endpoint.
Authenticate with a secret API key that has webhook access. Publishable keys cannot manage webhooks.
curl --request POST \
--url https://v2.prod.halliday.xyz/orgs/webhooks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"url": "https://api.yourapp.com/halliday/webhooks",
"label": "prod-workflows",
"event_types": [
"WORKFLOW_COMPLETED",
"WORKFLOW_FAILED"
],
"auth_header": {
"name": "X-Webhook-Token",
"value": "a-shared-secret-token"
}
}
'import requests
url = "https://v2.prod.halliday.xyz/orgs/webhooks"
payload = {
"url": "https://api.yourapp.com/halliday/webhooks",
"label": "prod-workflows",
"event_types": ["WORKFLOW_COMPLETED", "WORKFLOW_FAILED"],
"auth_header": {
"name": "X-Webhook-Token",
"value": "a-shared-secret-token"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
url: 'https://api.yourapp.com/halliday/webhooks',
label: 'prod-workflows',
event_types: ['WORKFLOW_COMPLETED', 'WORKFLOW_FAILED'],
auth_header: {name: 'X-Webhook-Token', value: 'a-shared-secret-token'}
})
};
fetch('https://v2.prod.halliday.xyz/orgs/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://v2.prod.halliday.xyz/orgs/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([
'url' => 'https://api.yourapp.com/halliday/webhooks',
'label' => 'prod-workflows',
'event_types' => [
'WORKFLOW_COMPLETED',
'WORKFLOW_FAILED'
],
'auth_header' => [
'name' => 'X-Webhook-Token',
'value' => 'a-shared-secret-token'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://v2.prod.halliday.xyz/orgs/webhooks"
payload := strings.NewReader("{\n \"url\": \"https://api.yourapp.com/halliday/webhooks\",\n \"label\": \"prod-workflows\",\n \"event_types\": [\n \"WORKFLOW_COMPLETED\",\n \"WORKFLOW_FAILED\"\n ],\n \"auth_header\": {\n \"name\": \"X-Webhook-Token\",\n \"value\": \"a-shared-secret-token\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://v2.prod.halliday.xyz/orgs/webhooks")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"https://api.yourapp.com/halliday/webhooks\",\n \"label\": \"prod-workflows\",\n \"event_types\": [\n \"WORKFLOW_COMPLETED\",\n \"WORKFLOW_FAILED\"\n ],\n \"auth_header\": {\n \"name\": \"X-Webhook-Token\",\n \"value\": \"a-shared-secret-token\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://v2.prod.halliday.xyz/orgs/webhooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"https://api.yourapp.com/halliday/webhooks\",\n \"label\": \"prod-workflows\",\n \"event_types\": [\n \"WORKFLOW_COMPLETED\",\n \"WORKFLOW_FAILED\"\n ],\n \"auth_header\": {\n \"name\": \"X-Webhook-Token\",\n \"value\": \"a-shared-secret-token\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "4f2c…",
"label": "prod-workflows",
"url": "https://api.yourapp.com/halliday/webhooks",
"signing_secret": "a1b2c3…"
}{
"errors": [
{
"code": "invalid_type",
"expected": "string",
"path": [
"label"
],
"message": "Invalid input: expected string, received undefined"
}
]
}{
"errors": [
{
"kind": "other",
"message": "Invalid API key"
}
]
}{
"errors": [
{
"kind": "other",
"message": "Publishable keys cannot manage webhooks"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Receiver URL. Must be HTTPS on port 443. Private/reserved IP addresses are rejected (SSRF protection).
"https://api.yourapp.com/halliday/webhooks"
Human-readable identifier, unique per org. Used to address the webhook on update, rotate, and delete.
"prod-workflows"
At least one event type to subscribe to.
1Event type a webhook can subscribe to. WORKFLOW_COMPLETED fires when a workflow's status
becomes COMPLETE; WORKFLOW_FAILED fires when it becomes FAILED.
WORKFLOW_COMPLETED, WORKFLOW_FAILED ["WORKFLOW_COMPLETED", "WORKFLOW_FAILED"]
Optional custom HTTP header that Halliday attaches to every delivery to your receiver URL, so your
endpoint can authenticate inbound deliveries in addition to verifying X-Halliday-Signature. The
value is write-only — it is never returned by any endpoint; the list endpoint echoes only the
header name as auth_header_name.
Show child attributes
Show child attributes
Optional. Provide your own HMAC-SHA256 signing secret instead of letting Halliday generate
one. Omit this to receive a generated signing_secret in the response.
"my-own-signing-secret"
Response
Webhook registered successfully
A registered webhook including its signing secret. Returned only on creation and rotation.

