Skip to main content
POST
/
v1
/
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}}"
  }'

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

​
Request body

FieldTypeRequiredDescription
webhook_uuidstringYesUUID 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

FieldTypeDescription
pathstringURL path for the webhook template
methodstringHTTP method (e.g., “GET”, “POST”, “PUT”, “DELETE”)
timezonestringIANA timezone identifier indicating the timezone used for timestamps (matches your brand’s selected timezone)
inserted_atstringISO 8601 timestamp when the template was created (in your brand’s selected timezone with offset)
webhook_uuidstringUnique identifier for the webhook template
webhook_namestringName of the webhook template
headers_jsonobjectHTTP headers as JSON object (supports template variables)
query_params_jsonobjectQuery parameters as JSON object (supports template variables)
request_body_jsonobjectRequest body as JSON object (supports template variables)
expected_system_variablesarrayArray of system secret variable names expected in this template (e.g., ["api_key", "service_token"])
webhook_descriptionstringDescription of the webhook template
request_timeout_in_millisecondsintegerRequest timeout in milliseconds
max_retriesintegerMaximum number of retry attempts
retry_delayintegerDelay in seconds between retry attempts
retry_backoff_modestringRetry backoff strategy (“linear” or “exponential”)
domain_detailsobjectDomain information associated with this template
domain_details.domainstringDomain name
domain_details.protocol_typestringProtocol type (e.g., “https”, “http”)

​
Root fields

FieldTypeDescription
successbooleanIndicates if the request was successful
dataobjectWebhook 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