Create an event

POST

Headers

X-Disable-Hooks"true"Required

Request

This endpoint expects an object.

contextobjectRequired

The context of the event

domainenumRequired

The domain of the event

payloadmap from strings to anyRequired

topicenumRequired

The topic of the event

attributesobjectOptional

The attributes of the event

callbackUrlstringOptional

The callback url to acknowledge the event

dataUrlstringOptional

The url to retrieve the data associated with the event

deletedAtdatetimeOptional

Date the event was deleted

namespaceslist of stringsOptional

originobjectOptional

The origin resource of the event

targetstringOptional

Response

This endpoint returns an object.

dataobject

An event that tracks an activity within an environment

Errors

POST

1 curl -X POST https://api.x.flatfile.com/v1/events \
2      -H "X-Disable-Hooks: true" \
3      -H "Authorization: Bearer <token>" \
4      -H "Content-Type: application/json" \
5      -d '{
6   "context": {
7     "accountId": "us_acc_YOUR_ID",
8     "environmentId": "us_env_YOUR_ID",
9     "spaceId": "us_sp_YOUR_ID",
10     "workbookId": "us_wb_YOUR_ID",
11     "actorId": "us_key_SOME_KEY"
12   },
13   "domain": "workbook",
14   "payload": {
15     "recordsAdded": 100
16   },
17   "topic": "workbook:updated"
18 }'

200Example0

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

1	curl -X POST https://api.x.flatfile.com/v1/events \
2	-H "X-Disable-Hooks: true" \
3	-H "Authorization: Bearer <token>" \
4	-H "Content-Type: application/json" \
5	-d '{
6	"context": {
7	"accountId": "us_acc_YOUR_ID",
8	"environmentId": "us_env_YOUR_ID",
9	"spaceId": "us_sp_YOUR_ID",
10	"workbookId": "us_wb_YOUR_ID",
11	"actorId": "us_key_SOME_KEY"
12	},
13	"domain": "workbook",
14	"payload": {
15	"recordsAdded": 100
16	},
17	"topic": "workbook:updated"
18	}'

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	}