Skip to content
This repository has been archived by the owner on Mar 14, 2024. It is now read-only.

Commit

Permalink
docs: add event schema
Browse files Browse the repository at this point in the history
  • Loading branch information
tomwwinter committed Feb 9, 2024
1 parent 17d9415 commit 2ef54ce
Showing 1 changed file with 22 additions and 1 deletion.
23 changes: 22 additions & 1 deletion docs/api-specs/reporting-api-v1.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,9 @@ paths:
- report
summary: Trigger a new report calculation run.
description: Trigger a new report calculation run. Check status of the asynchronous calculation via the /report-calculation endpoint
(CURRENTLY UNDER DEVELOPMENT) optionally receive status updates via a webhook if that has been set up for the authorized client
As an alternative to triggering a single report calculation, you can subscribe to receive
a notification event (which includes an automatically created calculationId) whenever the report's
results change (see /webhook/{webhookId}/subscribe/report).
parameters:
- in: path
name: reportId
Expand Down Expand Up @@ -477,6 +479,25 @@ components:
headerName:
type: string

Event:
type: object
description: Representation of the payload we will send to the webhook
properties:
id:
type: string
format: uuid
eventName:
type: string
enum:
- NEW_REPORT_DATA_AVAILABLE
reportId:
type: string
calculationId:
type: string
created_at:
type: string
format: date

# global

Error:
Expand Down

0 comments on commit 2ef54ce

Please sign in to comment.