> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hookpulse.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Add System Secret

> Add a new secret to the System Secret Vault for use in webhook templates

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

<RequestExample>
  ```bash cURL theme={null}
  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}}"
    }'
  ```

  ```javascript JavaScript theme={null}
  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);
  ```

  ```python Python theme={null}
  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())
  ```

  ```ruby Ruby theme={null}
  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 PHP theme={null}
  <?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;
  ?>
  ```
</RequestExample>

## 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

<ResponseExample>
  ```json theme={null}
  {
    "success": true,
    "details": "Variable added successfully in vault"
  }
  ```
</ResponseExample>

## Error response

If a secret with the same key already exists:

<ResponseExample>
  ```json theme={null}
  {
    "error": "Key with same name already in database",
    "success": false,
    "secret_uuid": "{{secret_uuid}}"
  }
  ```
</ResponseExample>

## 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) |


## OpenAPI

````yaml POST /v1/api/add_system_secret/
openapi: 3.0.3
info:
  title: Hookpulse API
  description: >-
    Complete API documentation for Hookpulse. Build powerful integrations with
    our RESTful API.
  version: 1.0.0
  contact:
    name: Hookpulse Support
    email: care@hookpulse.io
    url: https://hookpulse.io
servers:
  - url: https://api.hookpulse.io
    description: Production server
security:
  - apiKeyAuth: []
    brandUuidAuth: []
paths:
  /v1/api/add_system_secret/:
    post:
      description: Add a new secret to the System Secret Vault for use in webhook templates
      requestBody:
        description: Secret configuration
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddSystemSecretRequest'
      responses:
        '200':
          description: Secret added successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddSystemSecretResponse'
        '400':
          description: Bad request (e.g., key already exists)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddSystemSecretErrorResponse'
components:
  schemas:
    AddSystemSecretRequest:
      required:
        - secret_key
        - secret_value
      type: object
      properties:
        secret_key:
          type: string
          description: Unique identifier/key name for the secret
        secret_value:
          type: string
          description: The secret value to store
    AddSystemSecretResponse:
      type: object
      properties:
        success:
          type: boolean
          description: Indicates if the request was successful
        details:
          type: string
          description: Success message
    AddSystemSecretErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Error message
        success:
          type: boolean
          description: Indicates if the request was successful
        secret_uuid:
          type: string
          description: UUID of the existing secret
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-hookpulse-api-key
      description: >-
        API key for authentication. Get this from your dashboard by selecting a
        brand and going to API Keys section.
    brandUuidAuth:
      type: apiKey
      in: header
      name: x-brand-uuid
      description: >-
        Brand UUID for authentication. Get this from your dashboard after adding
        a brand - it will be displayed in the UI.

````