How to Create API Keys and Webhooks in CarrierOS AI
API keys and webhooks connect CarrierOS AI to trusted external tools. They should be handled like passwords. Follow the steps below to create API keys and webhooks in CarrierOS AI, then confirm the saved result before the office relies on it.
On this page
- Quick answer
- Before you start
- Step-by-step instructions
- Review checklist
- What happens next
- Common problems
- Related guides
Create API keys and webhooks in CarrierOS AI: quick answer
Open API & Webhooks, create one key per trusted tool, choose only the scopes it needs, store the secret safely, and remove keys that are no longer used.
Before you start
- Use an owner or technical admin account.
- Know the external tool and what it needs to read or change.
- Do not create broad access without a reason.
Step-by-step instructions
- From Settings, open API & Webhooks.
- Name the API key for the tool.
- Choose the minimum scopes needed.
- Create the key.
- Copy and store the secret securely.
- Create webhook endpoints only for trusted URLs.
- Review keys and webhooks regularly.
Review checklist
Use this checklist before you save, send, approve, or rely on the record.
- Key name: Human label for the external tool.
- Scopes: What the key can read or update.
- Secret: Private key value shown only when created.
- Webhook URL: Destination that receives event notices.
- Events: Load, document, invoice, or other activity triggers.
What happens next
After connecting a tool, test with safe data and review logs or results before using it in daily work.
Common problems and fixes
- If a tool cannot connect, check scopes and URL.
- If a key may be exposed, revoke it and create a new one.
- If events do not arrive, review webhook endpoint and selected events.
Tips for carrier offices
- Never post API keys in chat or support messages.
- Use one key per tool.
- Remove unused keys.
