LearningSuite icon

LearningSuite

Interact with LearningSuite API (powered by agentur-systeme.de)

Actions100

Webhook → Create Webhook Subscription

AI-generated

Summary

Create a webhook subscription to receive specific event notifications from LearningSuite by specifying the target webhook URL and the event type to subscribe to, optionally filtering events with additional parameters per event type.

Inputs

  • Webhook URL (required) — The URL endpoint that will receive webhook event payloads.
  • Event Type (required) — The type of LearningSuite event to subscribe to, selected from predefined options such as community post events, course progress changes, login events, etc.
  • Additional Event-Specific Options — Optional filters or parameters specific to the chosen event type to refine which events trigger the webhook, for example specifying course ID, user ID, popup ID, or status filters.

Output shape

a single subscription object representing the created webhook subscription configuration

The output includes details of the subscribed event type and filters applied; the subscription becomes active to receive matching event notifications at the provided webhook URL.

Examples

Example 1: Subscribe to all 'Community Post Created' events at a given webhook URL

Webhook URL set to the target endpoint; event type set to 'communityPost.created'; optional filters for area or forum left empty to receive all posts.

Example 2: Subscribe to 'Login New' events filtered by login type and user role

Webhook URL provided; event type is 'login.new'; additional login options set to filter by a specific login method and user role.

Links

Discussion