Get Webhook Template by UUID

curl -X POST https://api.hookpulse.io/v1/api/single_webhook_template_detail/ \
  -H "x-hookpulse-api-key: {{x-hookpulse-api-key}}" \
  -H "x-brand-uuid: {{x-brand-uuid}}" \
  -H "Content-Type: application/json" \
  -d '{
    "webhook_uuid": "{{webhook_uuid}}"
  }'

const response = await fetch('https://api.hookpulse.io/v1/api/single_webhook_template_detail/', {
  method: 'POST',
  headers: {
    'x-hookpulse-api-key': '{{x-hookpulse-api-key}}',
    'x-brand-uuid': '{{x-brand-uuid}}',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    webhook_uuid: '{{webhook_uuid}}'
  })
});

const data = await response.json();
console.log(data);

import requests

url = 'https://api.hookpulse.io/v1/api/single_webhook_template_detail/'
headers = {
    'x-hookpulse-api-key': '{{x-hookpulse-api-key}}',
    'x-brand-uuid': '{{x-brand-uuid}}',
    'Content-Type': 'application/json'
}
payload = {
    'webhook_uuid': '{{webhook_uuid}}'
}

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

require 'net/http'
require 'json'
require 'uri'

uri = URI('https://api.hookpulse.io/v1/api/single_webhook_template_detail/')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Post.new(uri.path)
request['x-hookpulse-api-key'] = '{{x-hookpulse-api-key}}'
request['x-brand-uuid'] = '{{x-brand-uuid}}'
request['Content-Type'] = 'application/json'
request.body = {
  webhook_uuid: '{{webhook_uuid}}'
}.to_json

response = http.request(request)
puts JSON.parse(response.body)

<?php

$url = 'https://api.hookpulse.io/v1/api/single_webhook_template_detail/';
$data = [
    'webhook_uuid' => '{{webhook_uuid}}'
];

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'x-hookpulse-api-key: {{x-hookpulse-api-key}}',
    'x-brand-uuid: {{x-brand-uuid}}',
    'Content-Type: application/json'
]);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

{
  "data": {
    "path": "{{path}}",
    "method": "{{method}}",
    "timezone": "{{timezone}}",
    "inserted_at": "{{inserted_at}}",
    "webhook_uuid": "{{webhook_uuid}}",
    "webhook_name": "{{webhook_name}}",
    "headers_json": {
      "Authentication": "Bearer {{ #key }}"
    },
    "query_params_json": {
      "variable_path": "{{ initial.test_path }}"
    },
    "request_body_json": {
      "key1": "{{value1}}",
      "key2": "{{value2}}",
      "key3": "{{ initial.test_name }}",
      "key4": "{{ initial.test_name2 }}",
      "key5": "{{ #key }}"
    },
    "expected_system_variables": [],
    "webhook_description": "{{webhook_description}}",
    "request_timeout_in_milliseconds": {{request_timeout_in_milliseconds}},
    "max_retries": {{max_retries}},
    "retry_delay": {{retry_delay}},
    "retry_backoff_mode": "{{retry_backoff_mode}}",
    "domain_details": {
      "domain": "{{domain}}",
      "protocol_type": "{{protocol_type}}"
    }
  },
  "success": true
}

POST

api

single_webhook_template_detail

curl -X POST https://api.hookpulse.io/v1/api/single_webhook_template_detail/ \
  -H "x-hookpulse-api-key: {{x-hookpulse-api-key}}" \
  -H "x-brand-uuid: {{x-brand-uuid}}" \
  -H "Content-Type: application/json" \
  -d '{
    "webhook_uuid": "{{webhook_uuid}}"
  }'

const response = await fetch('https://api.hookpulse.io/v1/api/single_webhook_template_detail/', {
  method: 'POST',
  headers: {
    'x-hookpulse-api-key': '{{x-hookpulse-api-key}}',
    'x-brand-uuid': '{{x-brand-uuid}}',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    webhook_uuid: '{{webhook_uuid}}'
  })
});

const data = await response.json();
console.log(data);

import requests

url = 'https://api.hookpulse.io/v1/api/single_webhook_template_detail/'
headers = {
    'x-hookpulse-api-key': '{{x-hookpulse-api-key}}',
    'x-brand-uuid': '{{x-brand-uuid}}',
    'Content-Type': 'application/json'
}
payload = {
    'webhook_uuid': '{{webhook_uuid}}'
}

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

require 'net/http'
require 'json'
require 'uri'

uri = URI('https://api.hookpulse.io/v1/api/single_webhook_template_detail/')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Post.new(uri.path)
request['x-hookpulse-api-key'] = '{{x-hookpulse-api-key}}'
request['x-brand-uuid'] = '{{x-brand-uuid}}'
request['Content-Type'] = 'application/json'
request.body = {
  webhook_uuid: '{{webhook_uuid}}'
}.to_json

response = http.request(request)
puts JSON.parse(response.body)

<?php

$url = 'https://api.hookpulse.io/v1/api/single_webhook_template_detail/';
$data = [
    'webhook_uuid' => '{{webhook_uuid}}'
];

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'x-hookpulse-api-key: {{x-hookpulse-api-key}}',
    'x-brand-uuid: {{x-brand-uuid}}',
    'Content-Type: application/json'
]);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

{
  "data": {
    "path": "{{path}}",
    "method": "{{method}}",
    "timezone": "{{timezone}}",
    "inserted_at": "{{inserted_at}}",
    "webhook_uuid": "{{webhook_uuid}}",
    "webhook_name": "{{webhook_name}}",
    "headers_json": {
      "Authentication": "Bearer {{ #key }}"
    },
    "query_params_json": {
      "variable_path": "{{ initial.test_path }}"
    },
    "request_body_json": {
      "key1": "{{value1}}",
      "key2": "{{value2}}",
      "key3": "{{ initial.test_name }}",
      "key4": "{{ initial.test_name2 }}",
      "key5": "{{ #key }}"
    },
    "expected_system_variables": [],
    "webhook_description": "{{webhook_description}}",
    "request_timeout_in_milliseconds": {{request_timeout_in_milliseconds}},
    "max_retries": {{max_retries}},
    "retry_delay": {{retry_delay}},
    "retry_backoff_mode": "{{retry_backoff_mode}}",
    "domain_details": {
      "domain": "{{domain}}",
      "protocol_type": "{{protocol_type}}"
    }
  },
  "success": true
}

Retrieve detailed information about a specific webhook template by its UUID.

Base URL

All API requests should be made to:

https://api.hookpulse.io

Example request

curl -X POST https://api.hookpulse.io/v1/api/single_webhook_template_detail/ \
  -H "x-hookpulse-api-key: {{x-hookpulse-api-key}}" \
  -H "x-brand-uuid: {{x-brand-uuid}}" \
  -H "Content-Type: application/json" \
  -d '{
    "webhook_uuid": "{{webhook_uuid}}"
  }'

const response = await fetch('https://api.hookpulse.io/v1/api/single_webhook_template_detail/', {
  method: 'POST',
  headers: {
    'x-hookpulse-api-key': '{{x-hookpulse-api-key}}',
    'x-brand-uuid': '{{x-brand-uuid}}',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    webhook_uuid: '{{webhook_uuid}}'
  })
});

const data = await response.json();
console.log(data);

import requests

url = 'https://api.hookpulse.io/v1/api/single_webhook_template_detail/'
headers = {
    'x-hookpulse-api-key': '{{x-hookpulse-api-key}}',
    'x-brand-uuid': '{{x-brand-uuid}}',
    'Content-Type': 'application/json'
}
payload = {
    'webhook_uuid': '{{webhook_uuid}}'
}

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

require 'net/http'
require 'json'
require 'uri'

uri = URI('https://api.hookpulse.io/v1/api/single_webhook_template_detail/')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Post.new(uri.path)
request['x-hookpulse-api-key'] = '{{x-hookpulse-api-key}}'
request['x-brand-uuid'] = '{{x-brand-uuid}}'
request['Content-Type'] = 'application/json'
request.body = {
  webhook_uuid: '{{webhook_uuid}}'
}.to_json

response = http.request(request)
puts JSON.parse(response.body)

<?php

$url = 'https://api.hookpulse.io/v1/api/single_webhook_template_detail/';
$data = [
    'webhook_uuid' => '{{webhook_uuid}}'
];

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'x-hookpulse-api-key: {{x-hookpulse-api-key}}',
    'x-brand-uuid: {{x-brand-uuid}}',
    'Content-Type: application/json'
]);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Request body

Field	Type	Required	Description
`webhook_uuid`	string	Yes	UUID of the webhook template to retrieve

Example response

{
  "data": {
    "path": "{{path}}",
    "method": "{{method}}",
    "timezone": "{{timezone}}",
    "inserted_at": "{{inserted_at}}",
    "webhook_uuid": "{{webhook_uuid}}",
    "webhook_name": "{{webhook_name}}",
    "headers_json": {
      "Authentication": "Bearer {{ #key }}"
    },
    "query_params_json": {
      "variable_path": "{{ initial.test_path }}"
    },
    "request_body_json": {
      "key1": "{{value1}}",
      "key2": "{{value2}}",
      "key3": "{{ initial.test_name }}",
      "key4": "{{ initial.test_name2 }}",
      "key5": "{{ #key }}"
    },
    "expected_system_variables": [],
    "webhook_description": "{{webhook_description}}",
    "request_timeout_in_milliseconds": {{request_timeout_in_milliseconds}},
    "max_retries": {{max_retries}},
    "retry_delay": {{retry_delay}},
    "retry_backoff_mode": "{{retry_backoff_mode}}",
    "domain_details": {
      "domain": "{{domain}}",
      "protocol_type": "{{protocol_type}}"
    }
  },
  "success": true
}

Response fields

Data object

Field	Type	Description
`path`	string	URL path for the webhook template
`method`	string	HTTP method (e.g., “GET”, “POST”, “PUT”, “DELETE”)
`timezone`	string	IANA timezone identifier indicating the timezone used for timestamps (matches your brand’s selected timezone)
`inserted_at`	string	ISO 8601 timestamp when the template was created (in your brand’s selected timezone with offset)
`webhook_uuid`	string	Unique identifier for the webhook template
`webhook_name`	string	Name of the webhook template
`headers_json`	object	HTTP headers as JSON object (supports template variables)
`query_params_json`	object	Query parameters as JSON object (supports template variables)
`request_body_json`	object	Request body as JSON object (supports template variables)
`expected_system_variables`	array	Array of system secret variable names expected in this template (e.g., `["api_key", "service_token"]`)
`webhook_description`	string	Description of the webhook template
`request_timeout_in_milliseconds`	integer	Request timeout in milliseconds
`max_retries`	integer	Maximum number of retry attempts
`retry_delay`	integer	Delay in seconds between retry attempts
`retry_backoff_mode`	string	Retry backoff strategy (“linear” or “exponential”)
`domain_details`	object	Domain information associated with this template
`domain_details.domain`	string	Domain name
`domain_details.protocol_type`	string	Protocol type (e.g., “https”, “http”)

Root fields

Field	Type	Description
`success`	boolean	Indicates if the request was successful
`data`	object	Webhook template details object

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 template lookup request

webhook_uuid

string

required

UUID of the webhook template to retrieve

Response

Successful response

success

boolean

Indicates if the request was successful

data

object

Show child attributes

About HookPulse

API Reference

System Secret Vault

Domain Setup

Webhook Template

Workflow Template

Scheduling

Human Approval

Get Webhook Template by UUID

Base URL

Example request

Request body

Example response

Response fields

Data object

Root fields

Authorizations

Body

Response

​Base URL

​Example request

​Request body

​Example response

​Response fields

​Data object

​Root fields

Authorizations

Body

Response

Base URL

Example request

Request body

Example response

Response fields

Data object

Root fields