The following article covers the creation of secrets within the OneBlink LcS platform. Secrets are used to validate that the calls that your API receives to ensure they are legitimate.

Create a Secret

Step 1: Navigate to the Developer Tools section of the side menu and open the Secrets menu

Step 2: Click the red plus button in the bottom right to create a new secret.

Step 3: Now configure your secret:

• Label: Give the secret a name so that you can select it when configuring secrets elsewhere in the platform.
• Secret: The secret value, 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.

Step 4: Once you have created your secret, you will find it in the list of available secrets. 

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

1. Form Validation
2. Form Webhooks
3. Approval Webhooks

To use the secret, open the area where you would like to add the secret and choose from your available list of secrets. 

Alternatively you can create a secret directly from any of these secret inputs. 

Manage a Secret

From the secrets menu you can see if the secret is currently in use. If the secret is in use it will display a Forms tag and/or and approval webhook tag with a number highlighting how many forms or approval webhook the secret is used in. 

You are also able to edit the secret changing either the label or the secret value. You are also able to delete the secret. You are not able 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.

Getting Help

If you need any assistance with setting up a secret, please reach out through the Report Issue menu or email [email protected].