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

{
  "data": {
    "secret_key": "{{secret_key}}",
    "secret_value": "{{secret_value}}",
    "call_key": "{{ #secret_key }}",
    "secret_uuid": "{{secret_uuid}}"
  },
  "success": true
}
Retrieve the value and details of a specific system secret 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/get_value_of_secret/ \
  -H "x-hookpulse-api-key: {{x-hookpulse-api-key}}" \
  -H "x-brand-uuid: {{x-brand-uuid}}" \
  -H "Content-Type: application/json" \
  -d '{
    "secret_uuid": "{{secret_uuid}}"
  }'

​
Request body

FieldTypeRequiredDescription
secret_uuidstringYesUUID of the secret to retrieve

​
Example response

{
  "data": {
    "secret_key": "{{secret_key}}",
    "secret_value": "{{secret_value}}",
    "call_key": "{{ #secret_key }}",
    "secret_uuid": "{{secret_uuid}}"
  },
  "success": true
}

​
Response fields

​
Data object

FieldTypeDescription
secret_keystringThe secret key name
secret_valuestringThe actual secret value
call_keystringTemplate syntax to use this secret in webhooks (e.g., {{ #secret_key }})
secret_uuidstringUnique identifier for the secret

​
Root fields

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

Secret lookup request

​
secret_uuid
string
required

UUID of the secret to retrieve

Response

Successful response

​
success
boolean

Indicates if the request was successful

​
data
object