Create & Manage Secrets

Secrets are used to validate the calls that your API receives to ensure they are legitimate.

Create a Secret

1. Sign in to your site

2. Click on the Workflow navigation and select the Settings button
   

3. Navigate to Developer Tools and select the Secrets menu

4. Click the plus sign button in the bottom right corner

5. Add the Label and Secret

   • Label: Give the secret a name so that you can select it when configuring secrets elsewhere in the platform.

   • Secret: For best practice, ensure your secrets are more than 8 characters and include lowercase, uppercase, numbers, and special characters.

     Note:

     You will not be able to view the secret after it has been created.

6. Click Save

7. Now that the secret has been configured you can use it in 3 areas within the platform:

   • Form Validation

   • Form Webhooks

   • Approval Webhooks

Edit a Secret

1. Sign in to your site

2. Click on the Workflow navigation and select the Settings button
   

3. Navigate to Developer Tools and select the Secrets menu

4. If a secret is in use, it will display a Forms tag and/or an Approval Webhook tag with a number highlighting how many forms or approval Webhooks the secret is used in

5. To edit the secret, click the pencil icon

6. Update the Label or the Secret Value

7. Click Save

Delete a Secret

Note:

You are unable to delete a secret that is currently in use so make sure to remove the secret from any forms or approval webhooks it is being used in first.

1. Sign in to your site

2. Click on the Workflow navigation and select the Settings button
   

3. Navigate to Developer Tools and select the Secrets menu

4. Select the trashcan icon next to a secret

5. Select the Delete button on the pop-up that says Are you sure you want to delete this secret?