From b916388be99b73a1a6243f68be22cb799df5715e Mon Sep 17 00:00:00 2001 From: Sebastian Date: Fri, 9 Feb 2024 10:18:04 +0100 Subject: [PATCH] readme --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 96d9152..8520fdf 100644 --- a/README.md +++ b/README.md @@ -54,4 +54,11 @@ This returns a JWT access token required to provided as Bearer Token for any req 2. Request the all available reports: `GET /reports` (see OpenAPI specs for details) 3. Trigger the calculation of a reports data: `POST /report-calculation/` 4. Get status of the report calculation: `GET /report-calculation/` -5. Once the status shows the calculation is completed, get the actual result data: `GET /report-calculation//data` \ No newline at end of file +5. Once the status shows the calculation is completed, get the actual result data: `GET /report-calculation//data` + + +## Subscribe to continous changes of a report +1. Create an initial webhook (if not already registered): `POST /webhook` +2. Register for events of the selected report: `POST /webhook/{webhookId}/subscribe/report/{reportId}:` +3. You will receive Event objects to your webhook, including an initial event directly after you subscribe, pointing to the current report data +4. Use the report-calculation-id in the event to fetch actual data from /report-calculation endpoint \ No newline at end of file