Admin GuidesIntegrations (Video, API Keys, Webhooks)

Integrations

Who this guide is for: Tenant administrators who connect EmbayLMS to outside systems — video conferencing providers for instructor-led training, and the developer-facing API surface (API keys and webhooks).


Overview

All of your tenant’s built-in connectors live under a single Integrations item in the admin left navigation. Opening it shows a tabbed section with three tabs:

  • Video Conferencing — connect Zoom and Google Meet so ILT/VILT sessions get a join link created automatically.
  • API Keys — create and revoke server-to-server API keys for the EmbayLMS REST API.
  • Webhooks — register endpoints that receive event notifications, and review delivery logs.

This menu was consolidated from three former standalone menu items (Video Conferencing, API Keys, Webhooks) into one section with tabs (LMS-512). The old direct routes still work — see Legacy routes below.

To open it, navigate to Admin Panel > Settings > Integrations.


Prerequisites

  • Tenant Admin role (the entire Integrations section is admin-only)
  • For video conferencing: an account with the provider (Zoom or Google Workspace) and permission to create the required app credentials
  • For API keys / webhooks: a developer or system that will consume the EmbayLMS REST API

1 - Video Conferencing tab

The Video Conferencing tab lists every connected meeting account and lets you add, test, or disconnect one. When a provider is connected, EmbayLMS automatically creates a join link for each scheduled VILT (virtual instructor-led) session.

Two providers are supported:

Zoom

Zoom is connected with a Server-to-Server OAuth app, which provides three credentials. The full provider-side setup (creating the Server-to-Server OAuth app, scopes, and the attendance/recording webhook) is covered in the Zoom — VILT integration walkthrough.

  1. Go to Admin Panel > Settings > Integrations > Video Conferencing.
  2. Click Add account.
  3. Select Zoom as the provider.
  4. Enter a display name (how this account appears in the list, e.g. “Acme Zoom”).
  5. Enter the three credentials from your Zoom Server-to-Server OAuth app:
    • Account ID
    • Client ID
    • Client Secret
  6. Click Connect & verify. EmbayLMS validates the credentials before saving.

Google Meet

Google Meet is connected with a Google Cloud service account that impersonates a host mailbox via domain-wide delegation. The full provider-side setup (creating the service account, enabling delegation, granting Calendar scopes) is covered in the Google Meet — VILT integration walkthrough.

  1. Go to Admin Panel > Settings > Integrations > Video Conferencing.
  2. Click Add account.
  3. Select Google Meet as the provider.
  4. Enter a display name.
  5. Enter the host email — the Workspace mailbox the service account impersonates to create meetings.
  6. Paste the service account JSON key.
  7. Click Connect & verify.

Testing and disconnecting

Each connected account has two actions:

  • Test (refresh icon) — runs a live credential check and shows a pass/fail result inline.
  • Disconnect (trash icon) — removes the account after a confirmation prompt. Existing sessions keep their already-created join links.

2 - API Keys tab

API keys authenticate server-to-server calls to the EmbayLMS REST API (/api/v1/). See the API authentication guide for how to send the key on requests.

Create a key

  1. Go to Admin Panel > Settings > Integrations > API Keys.
  2. Click New API key.
  3. Enter a name (so you can identify the integration later).
  4. Select one or more scopes:
    • read — read-only access
    • write — create and update access
    • admin — full administrative access
  5. Click Create.
  6. The full key is shown once in a reveal banner. Copy it immediately and store it securely — it cannot be retrieved again. Only the key prefix is shown afterward.

Revoke a key

Click the delete (trash) action on a key row to revoke it. Revocation is immediate; any caller using that key will start receiving authentication errors.


3 - Webhooks tab

Webhooks push event notifications to an endpoint you host, so external systems can react to activity in EmbayLMS in near-real time. See the Webhooks guide for the payload format and signature verification.

Register an endpoint

  1. Go to Admin Panel > Settings > Integrations > Webhooks.
  2. Click New webhook.
  3. Enter the destination URL (must accept HTTPS POST).
  4. Select the events you want to receive. Available events include:
    • enrollment.created, enrollment.completed, enrollment.dropped
    • course.published, course.archived
    • user.created, user.deactivated
    • certificate.issued
  5. Click Create.
  6. The signing secret is shown once in a reveal banner. Copy it and store it securely — use it to verify the signature on incoming deliveries.

Delivery logs

Each endpoint row shows a delivery count. Use the delivery history to confirm events are being sent and to diagnose failures (non-2xx responses from your endpoint). Toggle an endpoint inactive to pause deliveries without deleting it.


Configuration Reference

TabRouteWhat it does
Video Conferencing/admin/settings/integrationsConnect, test, and disconnect Zoom and Google Meet accounts for VILT join links
API Keys/admin/settings/integrations/api-keysCreate and revoke scoped server-to-server REST API keys
Webhooks/admin/settings/integrations/webhooksRegister event endpoints, manage events, and view delivery logs

Legacy routes

The previous standalone routes redirect to the corresponding tab, so existing bookmarks keep working:

Old routeRedirects to
/admin/settings/api-keys/admin/settings/integrations/api-keys
/admin/settings/webhooks/admin/settings/integrations/webhooks

Troubleshooting

ProblemResolution
”Connect & verify” fails for ZoomRe-check the Account ID, Client ID, and Client Secret from your Server-to-Server OAuth app. Confirm the app is activated in the Zoom Marketplace and has meeting create/read scopes.
”Connect & verify” fails for Google MeetConfirm domain-wide delegation is enabled, the Calendar scopes are granted, and the host email is a real Workspace mailbox. See the Google Meet walkthrough.
VILT session has no join linkConfirm a matching provider account is connected on the Video Conferencing tab and that Test passes for it.
Lost an API keyKeys are shown only once at creation and cannot be recovered. Revoke the old key and create a new one.
Webhook deliveries are failingCheck the delivery logs for the endpoint. Your endpoint must return a 2xx status; verify the URL is reachable over HTTPS and the signature check on your side uses the signing secret shown at creation.
Old API Keys / Webhooks bookmark 404sUse the new routes under /admin/settings/integrations/ — the old routes redirect automatically (see Legacy routes).