Webhooks
Create webhooks, choose event types, verify signatures, and review delivery health.
Use Webhooks when Built LMS needs to notify another system after events happen.
Before you begin
You need permission to manage integrations or webhooks. You also need the receiving system's HTTPS endpoint and a person who can verify received events.
Before creating a webhook, confirm:
- The endpoint URL.
- Which events the receiving system expects.
- How the receiving system will verify signatures.
- Whether you should start with a test or staging endpoint.
- Who owns failed-delivery review.
Create and secure a webhook
Create a webhook
- Open Settings > Integrations > Webhooks.
- Select Create Webhook.
- Enter a clear name.
- Enter the endpoint URL.
- Choose event types.
- Save the webhook.
- Copy or store the signing secret if the page shows one.
- Send or wait for a test event.
Use the fewest event types the receiving system needs. Extra events make the receiver harder to monitor and debug.
Choose webhook event types
Choose events based on the receiving system's job.
Examples:
- Enrollment events for provisioning or CRM updates.
- Completion events for compliance records.
- Certificate events for credential workflows.
- Purchase or subscription events for commerce operations when monetization is enabled.
Do not subscribe to broad event sets just because they are available.
Verify webhook signatures
Use the webhook signing secret in the receiving system so it can confirm events came from Built LMS.
If a signing secret is rotated, update the receiving system before relying on new deliveries.
Monitor webhook delivery
Manage webhooks
Review webhook list entries for:
- Name.
- Endpoint URL.
- Enabled or disabled state.
- Event types.
- Last delivery status.
- Recent failures.
Disable a webhook when the receiving system is being retired or when failed deliveries are causing noise during an incident.
Review delivery metrics
Use delivery metrics to confirm whether events are being sent and accepted.
Watch for:
- Repeated non-2xx responses.
- Timeouts.
- Sudden drops in delivery volume.
- Failures after endpoint, DNS, firewall, or authentication changes.
Review failed deliveries
Open failed deliveries to inspect status code, timestamp, event type, endpoint, and error details.
Share the failed delivery details with the owner of the receiving system. Avoid resending events repeatedly until the endpoint issue is understood.
Verify and support webhooks
Verify success
Webhooks are working when:
- The webhook is enabled.
- The endpoint receives the expected event types.
- The receiver verifies signatures.
- Recent deliveries show success.
- Failed deliveries have an owner and review path.
Troubleshooting
Confirm the webhook is enabled, event types are selected, and the triggering event actually happened. Then check delivery metrics.
Check endpoint URL, status code, timeout, firewall rules, and receiver logs. Send the failed delivery details to the endpoint owner.
Confirm the receiver is using the current signing secret and the expected signature header. Rotate the secret only after coordinating with the receiver.