Integrations Overview
Choose the right integration guide for connected apps, live learning platforms, API credentials, and webhooks.
Use this overview when you need to connect Built LMS to another system, create developer credentials, or send events to an external endpoint.
Before you begin
You need access to Admin Dashboard > Settings > Integrations. Creating or editing credentials, connected apps, and webhooks may require integration or settings permissions.
Before making integration changes, confirm:
- Which external system needs access.
- Whether the integration should read data, write data, or receive events.
- Who owns the external system.
- Where credentials will be stored.
- How the integration will be tested before broad use.
Choose the right integration guide
| If you need to... | Start here |
|---|---|
| Review, connect, reconnect, or disconnect a partner app | Third-Party Apps |
| Create OAuth applications or API keys for server-to-server or custom app access | API Access |
| Build against the public REST API or import the OpenAPI reference | Developer API |
| Send Built LMS events to an external endpoint | Webhooks |
| Connect Zoom, Google Meet, Microsoft Teams, or Livestorm | Connect a Live Learning Platform |
| Investigate integration, API, or authentication audit events | Audit Trail and Diagnostics |
Recommended setup order
For a new integration:
- Confirm whether a built-in third-party app or live learning platform setup already exists.
- Use OAuth applications or API keys only when a custom system needs direct access.
- Use webhooks only when an external endpoint needs event notifications.
- Limit permissions to the smallest set the integration needs.
- Test with a pilot user, test record, or non-production endpoint first.
- Review audit logs after the first successful run.
Verify and support integrations
Verify success
The integration path is correct when:
- Built-in app setup is used before custom credentials.
- API credentials have only the permissions the integration needs.
- Webhooks send only the event types the receiving system expects.
- Credential owners know where secrets are stored.
- Audit logs show the expected connection, credential, or delivery activity.
Troubleshooting
Use API Access when an external system needs to call Built LMS. Use Webhooks when Built LMS needs to notify an external system after events happen.
Start with Third-Party Apps, then check audit logs for authentication, authorization, or sync errors.
Review the OAuth scopes or API key permissions in API Access. Rotate or revoke credentials when they were shared too broadly.
Open Webhooks. Check endpoint URL, event types, signing secret, delivery metrics, and failed deliveries.