Skip to main content
POST
/
v1
/
api
/
get_webhook_template_uuid
curl -X POST https://api.hookpulse.io/v1/api/get_webhook_template_uuid/ \
  -H "x-hookpulse-api-key: {{x-hookpulse-api-key}}" \
  -H "x-brand-uuid: {{x-brand-uuid}}" \
  -H "Content-Type: application/json" \
  -d '{
    "webhook_name": "{{webhook_name}}"
  }'

{
  "success": true,
  "webhook_uuid": "{{webhook_uuid}}"
}
Retrieve the UUID of a webhook template by providing its name.

​
Base URL

All API requests should be made to: 
https://api.hookpulse.io

​
Example request

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

​
Request body

FieldTypeRequiredDescription
webhook_namestringYesName of the webhook template

​
Example response

​
Success response

{
  "success": true,
  "webhook_uuid": "{{webhook_uuid}}"
}

​
Error response

{
  "error": "Webhook not found",
  "success": false
}

​
Response fields

​
Success response

FieldTypeDescription
successbooleanIndicates if the request was successful (always true on success)
webhook_uuidstringUnique identifier for the webhook template

​
Error response

FieldTypeDescription
successbooleanIndicates if the request was successful (always false on error)
errorstringError message describing what went wrong

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 by name

​
webhook_name
string
required

Name of the webhook template

Response

Successful response

​
success
boolean

Indicates if the request was successful

​
webhook_uuid
string

Unique identifier for the webhook template