Search...
/
Community
Create Account
Sign in
Overview
Welcome
Authentication
Using Environments
API Reference
Accounts
Actions
Agents
Apps
Assistant
Commits
Data Retention Policies
Documents
Entitlements
Environments
Events
GET
List events
POST
Create an event
GET
Get an event
POST
Acknowledge an event
GET
Get subscription credentials
Files
Guests
Jobs
Mapping
Records
Roles
Secrets
Sheets
Snapshots
Spaces
Users
Versions
Views
Workbooks
Community
Create Account
Sign in
API Reference
Events
Create an event
POST
https://api.x.flatfile.com/v1
/
events
Request
This endpoint expects an object.
context
object
Required
The context of the event
Show 20 properties
domain
enum
Required
The domain of the event
Show 10 enum values
payload
map from strings to any
Required
topic
enum
Required
The topic of the event
Show 58 enum values
attributes
object
Optional
The attributes of the event
Show 2 properties
callbackUrl
string
Optional
The callback url to acknowledge the event
dataUrl
string
Optional
The url to retrieve the data associated with the event
deletedAt
datetime
Optional
Date the event was deleted
namespaces
list of strings
Optional
origin
object
Optional
The origin resource of the event
Show 2 properties
target
string
Optional
Response
This endpoint returns an object.
data
object
An event that tracks an activity within an environment
Show 53 variants
Errors
400
Bad Request
404
Not Found
Built with