Skip to content

Implement webhook in OCL for external sync and workflow automation #2535

@filiperochalopes

Description

@filiperochalopes

User story

As an OCL user, I want webhook notifications for key events so external systems can stay synchronized and workflows can be automated based on actions performed in OCL.

Use case

  1. Third-party applications keep a cache of recent updates and stay synchronized with OCL REST/CIEL Lab by consuming webhook events.
  2. Workflow automation (e.g., n8n) triggers WhatsApp/email notifications based on OCL actions; for example, when a concept is edited in a source via REST and needs curator review, the curator receives a notification with a link to the concept.
  • Outsite AI workflow to review any concept using AI, labeling, after beeing posted, ...

Requirements

  • Provide a webhook feature that emits events for relevant actions in OCL (e.g., concept edited/updated).
  • Allow external systems to subscribe to webhook events.
  • Include enough information in the webhook payload for:
    • external cache synchronization, and
    • workflow triggers to notify a curator and link to the affected concept.

Acceptance criteria

  • Given a concept is edited via REST, a webhook event is delivered to subscribed endpoints.
  • The webhook payload enables a third-party app to update its cache of recent changes.
  • The webhook payload enables an automation flow to notify a curator that a concept requires review and direct them to the concept.

Metadata

Metadata

Assignees

Labels

signal/large-scopeAffects multiple areas or systemssignal/needs-specMissing detail or ambiguous requirementsstage/triagedAI triage complete — scored and classifiedtype/featureNew or improved functionality
No fields configured for Feature.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions