Getting Here

Settings > API Keys

API Shared Secret Button

The API Shared Secret button allows administrators to view, regenerate, and manage the shared secret used for encoding and validating API keys.

Fields

1. Shared Secret
   • Description: Displays the current shared secret.
   • Purpose:
     • Used to encode and validate API keys.
     • Ensures secure communication for API integrations.
   • Action:
     • Copy Button: Copies the shared secret to the clipboard for use in API integrations.

Actions

1. REGENERATE

   • Description: Generates a new shared secret.
   • Behavior:
     • Invalidates all current API integrations immediately.
     • Requires updating existing API integrations to use the new shared secret.

2. CANCEL

   • Description: Closes the modal without making any changes to the shared secret.

Notes

• Regeneration Impact:
  Regenerating the shared secret will render all existing API keys invalid until they are updated with the new shared secret.
• Usage: Use the Copy Button to ensure accuracy when updating API integrations with the shared secret.