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

{
  "success": true,
  "details": "Variable added successfully in vault"
}
Add a new secret to the System Secret Vault for use in webhook templates.

​
Base URL

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

​
Example request

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

​
Request body

FieldTypeRequiredDescription
secret_keystringYesUnique identifier/key name for the secret
secret_valuestringYesThe secret value to store

​
Example response

{
  "success": true,
  "details": "Variable added successfully in vault"
}

​
Error response

If a secret with the same key already exists: 
{
  "error": "Key with same name already in database",
  "success": false,
  "secret_uuid": "{{secret_uuid}}"
}

​
Response fields

FieldTypeDescription
successbooleanIndicates if the request was successful
detailsstringSuccess message (only present on success)
errorstringError message (only present on error)
secret_uuidstringUUID of the existing secret (only present on error)

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 configuration

​
secret_key
string
required

Unique identifier/key name for the secret

​
secret_value
string
required

The secret value to store

Response

Secret added successfully

​
success
boolean

Indicates if the request was successful

​
details
string

Success message