Events

List events

GET
Event topics that the Flatfile Platform emits.

Query parameters

environmentIdstringOptional
Filter by environment
spaceIdstringOptional
Filter by space
domainstringOptional
Filter by event domain
topicstringOptional
Filter by event topic
sincedatetimeOptional
Filter by event timestamp
pageSizeintegerOptional
Number of results to return in a page (default 10)
pageNumberintegerOptional
Based on pageSize, which page of results to return
includeAcknowledgedbooleanOptional
Include acknowledged events

Response

This endpoint returns an object
data
list of unions
An event that tracks an activity within an environment
GET
$curl https://api.x.flatfile.com/v1/events \
>     -H "Authorization: Bearer <token>"
Response
1{
2  "data": [
3    {
4      "topic": "workbook:updated",
5      "context": {
6        "accountId": "us_acc_YOUR_ID",
7        "environmentId": "us_env_YOUR_ID",
8        "spaceId": "us_sp_YOUR_ID",
9        "workbookId": "us_wb_YOUR_ID",
10        "actorId": "us_key_SOME_KEY"
11      },
12      "createdAt": "2023-11-07T20:46:04.300Z",
13      "domain": "workbook",
14      "id": "us_evt_YOUR_ID",
15      "payload": {
16        "recordsAdded": 100
17      },
18      "callbackUrl": "",
19      "dataUrl": "",
20      "namespaces": [
21        "workbook"
22      ],
23      "origin": {
24        "id": "us_wb_YOUR_ID"
25      }
26    }
27  ]
28}
Built with