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}}"
}'
const response = await fetch('https://api.hookpulse.io/v1/api/add_system_secret/', {
method: 'POST',
headers: {
'x-hookpulse-api-key': '{{x-hookpulse-api-key}}',
'x-brand-uuid': '{{x-brand-uuid}}',
'Content-Type': 'application/json'
},
body: JSON.stringify({
secret_key: '{{secret_key}}',
secret_value: '{{secret_value}}'
})
});
const data = await response.json();
console.log(data);
import requests
url = 'https://api.hookpulse.io/v1/api/add_system_secret/'
headers = {
'x-hookpulse-api-key': '{{x-hookpulse-api-key}}',
'x-brand-uuid': '{{x-brand-uuid}}',
'Content-Type': 'application/json'
}
payload = {
'secret_key': '{{secret_key}}',
'secret_value': '{{secret_value}}'
}
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/add_system_secret/')
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 = {
secret_key: '{{secret_key}}',
secret_value: '{{secret_value}}'
}.to_json
response = http.request(request)
puts JSON.parse(response.body)
<?php
$url = 'https://api.hookpulse.io/v1/api/add_system_secret/';
$data = [
'secret_key' => '{{secret_key}}',
'secret_value' => '{{secret_value}}'
];
$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;
?>
{
"success": true,
"details": "Variable added successfully in vault"
}
System Secret Vault
Add System Secret
Add a new secret to the System Secret Vault for use in webhook templates
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}}"
}'
const response = await fetch('https://api.hookpulse.io/v1/api/add_system_secret/', {
method: 'POST',
headers: {
'x-hookpulse-api-key': '{{x-hookpulse-api-key}}',
'x-brand-uuid': '{{x-brand-uuid}}',
'Content-Type': 'application/json'
},
body: JSON.stringify({
secret_key: '{{secret_key}}',
secret_value: '{{secret_value}}'
})
});
const data = await response.json();
console.log(data);
import requests
url = 'https://api.hookpulse.io/v1/api/add_system_secret/'
headers = {
'x-hookpulse-api-key': '{{x-hookpulse-api-key}}',
'x-brand-uuid': '{{x-brand-uuid}}',
'Content-Type': 'application/json'
}
payload = {
'secret_key': '{{secret_key}}',
'secret_value': '{{secret_value}}'
}
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/add_system_secret/')
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 = {
secret_key: '{{secret_key}}',
secret_value: '{{secret_value}}'
}.to_json
response = http.request(request)
puts JSON.parse(response.body)
<?php
$url = 'https://api.hookpulse.io/v1/api/add_system_secret/';
$data = [
'secret_key' => '{{secret_key}}',
'secret_value' => '{{secret_value}}'
];
$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;
?>
{
"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}}"
}'
const response = await fetch('https://api.hookpulse.io/v1/api/add_system_secret/', {
method: 'POST',
headers: {
'x-hookpulse-api-key': '{{x-hookpulse-api-key}}',
'x-brand-uuid': '{{x-brand-uuid}}',
'Content-Type': 'application/json'
},
body: JSON.stringify({
secret_key: '{{secret_key}}',
secret_value: '{{secret_value}}'
})
});
const data = await response.json();
console.log(data);
import requests
url = 'https://api.hookpulse.io/v1/api/add_system_secret/'
headers = {
'x-hookpulse-api-key': '{{x-hookpulse-api-key}}',
'x-brand-uuid': '{{x-brand-uuid}}',
'Content-Type': 'application/json'
}
payload = {
'secret_key': '{{secret_key}}',
'secret_value': '{{secret_value}}'
}
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/add_system_secret/')
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 = {
secret_key: '{{secret_key}}',
secret_value: '{{secret_value}}'
}.to_json
response = http.request(request)
puts JSON.parse(response.body)
<?php
$url = 'https://api.hookpulse.io/v1/api/add_system_secret/';
$data = [
'secret_key' => '{{secret_key}}',
'secret_value' => '{{secret_value}}'
];
$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 |
|---|---|---|---|
secret_key | string | Yes | Unique identifier/key name for the secret |
secret_value | string | Yes | The 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
| Field | Type | Description |
|---|---|---|
success | boolean | Indicates if the request was successful |
details | string | Success message (only present on success) |
error | string | Error message (only present on error) |
secret_uuid | string | UUID of the existing secret (only present on error) |
Authorizations
API key for authentication. Get this from your dashboard by selecting a brand and going to API Keys section.
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
⌘I