Events

Get an event

GET

Path parameters

eventIdstringRequired
The event id

Response

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