Skip to main content

Search

We are excited to announce the launch of updated product names, logos, and headers within our user interfaces as part of the CivicPlus® Solution Rebranding initiative. These changes mark the first step toward creating a cohesive and seamless user experience across all solutions in our portfolio. As part of this transition, users may notice minor design updates. While the functionality you rely on remains unchanged, we are in the process of updating screenshots and other resources on our Help Centers to reflect the new branding. We appreciate your patience and understanding as we work to complete these updates.

Create & Manage Secrets

  • Updated:

Secrets are used to validate the calls that your API (Application Programming Interface) receives to ensure they are legitimate.

 

Article Navigation

 

Create a Secret

  1. Sign in to your site
  2. Navigate to Developer Tools and select the Secrets menu
    Secrets menu.
  3. Click the plus sign button in the bottom right corner
    Create new secret button.
  4. Add the Label and Secret
    Create fields.
    • 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.
  5. Click Save
    Save new secret.
  6. Now that the secret has been configured you can use it in 3 areas within the platform:

 

Go to Article Navigation

 

Edit a Secret

  1. Sign in to your site
  2. Navigate to Developer Tools and select the Secrets menu
    Secrets menu.
  3. 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
    Forms tag.
  4. To edit the secret, click the pencil icon
    Edit button.
  5. Update the Label or the Secret Value
    Edit label or secret.
  6. Click Save
    Save secret.

 

Go to Article Navigation

 

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. Navigate to Developer Tools and select the Secrets menu
    Secrets menu.
  3. Select the trashcan icon next to a secret
    Delete button.
  4. Select the Delete button on the pop-up that says Are you sure you want to delete this secret?
    Delete confirmation.

 

Go to Article Navigation

Comments

Let us know what was helpful or not helpful about the article.

0 comments

Please sign in to leave a comment.