Webhook Events

cURL

curl --request POST \
  --url https://api.hookpulse.io/webhook \
  --header 'Content-Type: application/json' \
  --header 'x-brand-uuid: <api-key>' \
  --header 'x-hookpulse-api-key: <api-key>' \
  --data '
{
  "data": {},
  "timestamp": "2023-11-07T05:31:56Z"
}
'

import requests

url = "https://api.hookpulse.io/webhook"

payload = {
    "data": {},
    "timestamp": "2023-11-07T05:31:56Z"
}
headers = {
    "x-hookpulse-api-key": "<api-key>",
    "x-brand-uuid": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-hookpulse-api-key': '<api-key>',
    'x-brand-uuid': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({data: {}, timestamp: '2023-11-07T05:31:56Z'})
};

fetch('https://api.hookpulse.io/webhook', 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.hookpulse.io/webhook",
  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([
    'data' => [
        
    ],
    'timestamp' => '2023-11-07T05:31:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-brand-uuid: <api-key>",
    "x-hookpulse-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.hookpulse.io/webhook"

	payload := strings.NewReader("{\n  \"data\": {},\n  \"timestamp\": \"2023-11-07T05:31:56Z\"\n}")

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

	req.Header.Add("x-hookpulse-api-key", "<api-key>")
	req.Header.Add("x-brand-uuid", "<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.hookpulse.io/webhook")
  .header("x-hookpulse-api-key", "<api-key>")
  .header("x-brand-uuid", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"data\": {},\n  \"timestamp\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hookpulse.io/webhook")

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

request = Net::HTTP::Post.new(url)
request["x-hookpulse-api-key"] = '<api-key>'
request["x-brand-uuid"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"data\": {},\n  \"timestamp\": \"2023-11-07T05:31:56Z\"\n}"

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

{
  "event": "resource.created",
  "data": {
    "id": "res_1234567890",
    "name": "My New Resource",
    "type": "webhook",
    "created_at": "2024-01-01T00:00:00Z"
  },
  "timestamp": "2024-01-01T00:00:00Z"
}

POST

webhook

cURL

curl --request POST \
  --url https://api.hookpulse.io/webhook \
  --header 'Content-Type: application/json' \
  --header 'x-brand-uuid: <api-key>' \
  --header 'x-hookpulse-api-key: <api-key>' \
  --data '
{
  "data": {},
  "timestamp": "2023-11-07T05:31:56Z"
}
'

import requests

url = "https://api.hookpulse.io/webhook"

payload = {
    "data": {},
    "timestamp": "2023-11-07T05:31:56Z"
}
headers = {
    "x-hookpulse-api-key": "<api-key>",
    "x-brand-uuid": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-hookpulse-api-key': '<api-key>',
    'x-brand-uuid': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({data: {}, timestamp: '2023-11-07T05:31:56Z'})
};

fetch('https://api.hookpulse.io/webhook', 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.hookpulse.io/webhook",
  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([
    'data' => [
        
    ],
    'timestamp' => '2023-11-07T05:31:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-brand-uuid: <api-key>",
    "x-hookpulse-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.hookpulse.io/webhook"

	payload := strings.NewReader("{\n  \"data\": {},\n  \"timestamp\": \"2023-11-07T05:31:56Z\"\n}")

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

	req.Header.Add("x-hookpulse-api-key", "<api-key>")
	req.Header.Add("x-brand-uuid", "<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.hookpulse.io/webhook")
  .header("x-hookpulse-api-key", "<api-key>")
  .header("x-brand-uuid", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"data\": {},\n  \"timestamp\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hookpulse.io/webhook")

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

request = Net::HTTP::Post.new(url)
request["x-hookpulse-api-key"] = '<api-key>'
request["x-brand-uuid"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"data\": {},\n  \"timestamp\": \"2023-11-07T05:31:56Z\"\n}"

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

{
  "event": "resource.created",
  "data": {
    "id": "res_1234567890",
    "name": "My New Resource",
    "type": "webhook",
    "created_at": "2024-01-01T00:00:00Z"
  },
  "timestamp": "2024-01-01T00:00:00Z"
}

Hookpulse sends webhook events to your configured endpoint when resources are created, updated, or deleted.

Setup

Navigate to your webhook settings in the dashboard
Click “Add Webhook”
Enter your webhook URL
Select the events you want to receive
Save your webhook configuration

Webhook signature

All webhook requests include a signature header for verification:

X-Hookpulse-Signature: sha256=...

Verify the signature using your webhook secret to ensure the request is from Hookpulse.

Event types

Event	Description
`resource.created`	Triggered when a new resource is created
`resource.updated`	Triggered when a resource is updated
`resource.deleted`	Triggered when a resource is deleted

Example payload

{
  "event": "resource.created",
  "data": {
    "id": "res_1234567890",
    "name": "My New Resource",
    "type": "webhook",
    "created_at": "2024-01-01T00:00:00Z"
  },
  "timestamp": "2024-01-01T00:00:00Z"
}

Response

Your webhook endpoint should return a 200 OK status code to acknowledge receipt of the event. Hookpulse will retry failed webhook deliveries up to 3 times with exponential backoff.

Authorizations

x-hookpulse-api-key

string

header

required

API key for authentication. Get this from your dashboard by selecting a brand and going to API Keys section.

x-brand-uuid

string

header

required

Brand UUID for authentication. Get this from your dashboard after adding a brand - it will be displayed in the UI.

Body

application/json

Webhook event payload

event

enum<string>

required

Type of event

Available options:

resource.created,

resource.updated,

resource.deleted

data

object

required

Event data payload

timestamp

string<date-time>

ISO 8601 timestamp of when the event occurred

Response

200

Webhook received successfully

About HookPulse

API Reference

System Secret Vault

Domain Setup

Webhook Template

Workflow Template

Scheduling

Human Approval

Setup

Webhook signature

Event types

Example payload

Response

Authorizations

Body

Response

​Setup

​Webhook signature

​Event types

​Example payload

​Response

Authorizations

Body

Response

Setup

Webhook signature

Event types

Example payload

Response