How to generate an API key

Before You Start

To generate an API key in MsgGO, you need:

• A MsgGO account
• Administrator privileges for your organization

Creating Your API Key

1. Log in to your MsgGO account
2. Click on "API Keys" in the left sidebar
3. Click the "New Key" button in the top right corner
4. Add a description for your key (recommended)
5. Save your new API key in a secure location

Best Practices for API Key Management

Adding Descriptions

Always add clear descriptions to your API keys to help identify their purpose. Good examples include:

• "Production API Key for Team Alpha"
• "Development Pipeline Key"
• "Testing Environment Key"

Security Guidelines

• Never share your API keys with unauthorized persons
• Store keys securely in environment variables or secure vaults
• Rotate keys periodically for better security
• Remove unused keys promptly

Organization Tips

• Create separate keys for different environments (development, staging, production)
• Use different keys for different teams or projects
• Keep track of where each key is being used
• Stay under the 100 key limit by removing unused keys

Key Limitations

• Each organization can have up to 100 active API keys
• All API keys have the same permissions
• Keys cannot be temporarily disabled (only deleted)
• Keys do not expire automatically
• Keys cannot be restricted to specific events or targets

Managing Existing Keys

To view or delete existing API keys:

1. Navigate to the "API Keys" section
2. View all your active keys and their descriptions
3. Use the delete button to remove unused or compromised keys

Next Steps

After generating your API key, you can:

• Deliver events to MsgGO
• Create your first event