Admin Keys

​

What are Admin Keys?

• Create and manage applications
• Manage app keys
• Purchase and assign phone numbers
• Manage organization settings
• View all organization data
• Manage team members and billing

​

Permissions

• Create new applications
• Update application settings
• Delete applications
• List all applications

• Create app keys (test and live)
• List app keys for any application
• Revoke app keys
• View app key details

• Purchase phone numbers
• Assign numbers to applications
• Remove numbers from applications
• View all organization phone numbers

• Update organization profile
• Manage billing information
• Configure organization-level webhooks
• View usage and analytics

​

Creating Admin Keys

1. Log in to the Chirp dashboard
2. Navigate to Organization Settings
3. Click on “Admin Keys”
4. Click “Create Admin Key”
5. Enter a descriptive name
6. Copy the key (shown only once)

• “Production Automation”
• “CI/CD Pipeline”
• “Infrastructure Scripts”
• “Development Tools”

​

Using Admin Keys

curl https://api.buildwithchirp.com/v1/organization/apps \
  -H "Authorization: Bearer sk_admin_abc123..."

​

Example: Create an Application

curl -X POST https://api.buildwithchirp.com/v1/organization/apps \
  -H "Authorization: Bearer YOUR_ADMIN_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My New App",
    "slug": "my-new-app"
  }'

​

Example: List All Applications

curl https://api.buildwithchirp.com/v1/organization/apps \
  -H "Authorization: Bearer YOUR_ADMIN_KEY"

​

Example: Create App Keys

curl -X POST https://api.buildwithchirp.com/v1/organization/apps/{appId}/keys \
  -H "Authorization: Bearer YOUR_ADMIN_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Production Server",
    "isTestKey": false
  }'

​

Security Best Practices

• ✅ “Production Automation Script”
• ✅ “CI/CD Pipeline - GitHub Actions”
• ❌ “Key 1”

1. Create a new admin key
2. Update all services to use the new key
3. Verify everything works
4. Delete the old key

• Environment variables
• Secrets management systems (AWS Secrets Manager, HashiCorp Vault)
• CI/CD secret stores

• Delete unused keys
• Verify key names are still accurate
• Check key activity in audit logs

​

Revoking Admin Keys

1. Go to Organization Settings > Admin Keys
2. Find the key to revoke
3. Click “Delete” and confirm

1. Identify all services using the key
2. Create and deploy a replacement key
3. Verify services work with new key
4. Revoke the old key

​

Admin Keys vs App Keys

​

Use Cases

• Create applications for new projects
• Provision phone numbers automatically
• Generate app keys for new environments

• Define applications declaratively
• Provision resources programmatically
• Keep infrastructure in sync

• Create test applications automatically
• Generate test keys for each branch
• Clean up resources after tests

• Create applications per customer
• Isolate customer data
• Manage resources programmatically

​

Troubleshooting

• Verify the admin key format (sk_admin_*)
• Check the key hasn’t been deleted
• Ensure you’re using an admin key (not an app key)

• Verify the operation requires admin-level access
• Check you’re not trying to send messages (use app keys)

• Admin keys are active immediately
• Verify you copied the entire key
• Check for extra spaces or newlines