[Documentation] Publish documentation of webhooks based on the transformation service

[hansen-maria]

Create, finalize, and publish documentation about webhooks, using the ABCD2BioSchema Transformation Service as a concrete example. The documentation should explain the general webhook concept, design patterns, and lifecycle, while illustrating these aspects with the real-world implementation of this service.

Workplan

1. Review the existing README of the ABCD2BioSchema Transformation Service with a focus on webhook usage.
2. Define the scope and structure of a general webhook documentation (concepts, triggers, payloads, callbacks, error handling).
3. Describe general webhook principles (event-based triggering, asynchronous processing, retries, status callbacks).
4. Map these principles to the ABCD2BioSchema Transformation Service as a practical example.
5. Document the webhook setup in Aruna, including trigger conditions and expected behavior.
6. Describe the end-to-end webhook workflow from event trigger to callback.
7. Review the documentation for clarity, technical correctness, and reusability.
8. Publish the documentation in the docs and ensure proper linking.

Definition of Done

• General webhook concepts are clearly explained.
• The ABCD2BioSchema Transformation Service is documented as an illustrative example.
• Webhook triggers, request/response flow, and callbacks are described.
• Error handling and failure scenarios are documented.
• Documentation is published in the project’s own docs.
• The documentation can serve as a reference for implementing other webhook-based services.

Risks Blockers

• Overemphasis on service-specific details instead of general webhook concepts.