API Keys

Broxi API allows you to trigger workflows securely from external applications using API Keys. This section covers everything you need to know to generate, manage, and use your API Keys.

1. Introduction

The Broxi API enables seamless integration between Broxi workflows and your external systems (web apps, mobile apps, backend services).

Using an API Key, authorized applications can securely initiate a workflow with custom input data.

2. API Key Management

How to create an API Key:

1. Go to Broxi API Keys section.

2. Click + Add New.

3. Enter a description for your API Key (optional, for internal reference).

4. Click Generate API Key.

5. Important: Copy and store your key securely. You won't be able to see it again.

6. After creation, the key will appear in your list with metadata:

   • Created Date

   • Last Used

   • Total Uses

Best Practices:

• Keep your API Key secret. Never share it publicly or expose it in client-side code.

• Rotate your keys periodically for better security.

• Delete unused keys immediately.

3. Security Notice

• Treat your API Key like a password.

• If an API Key is compromised, delete it immediately and generate a new one.

• Always use HTTPS to protect data in transit.