Skip to main content
Use webhooks when you want a system outside Clearline to react to workspace activity. Webhook availability and event coverage may depend on your workspace configuration.

​
Planning checklist

Before creating a webhook integration, decide:
  • Which event should trigger the integration.
  • Which external system should receive the event.
  • Whether the receiver can respond quickly with a success status.
  • How failures and retries should be monitored.
  • Which fields the receiver needs from Clearline.

​
Receiver requirements

Your receiver should:
  • Use HTTPS.
  • Return a 2xx status for successfully accepted events.
  • Validate any signature or shared secret configured for the endpoint.
  • Process long-running work asynchronously after acknowledging the event.
  • Log event IDs to make retries idempotent.
  1. Build and test a receiver locally.
  2. Expose it through a secure tunnel for development.
  3. Register the production endpoint.
  4. Send a test event.
  5. Monitor delivery logs.
  6. Add alerting for repeated failures.
Do not put webhook secrets in client-side code, screenshots, or public repositories.
Screenshot placeholder: add the webhook endpoint configuration once the production UI is finalized.