How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Flatfile Subpackage Events API

The subpackage_events API from Flatfile — 4 operation(s) for subpackage_events.

Flatfile Subpackage Events API is one of 32 APIs that Flatfile publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

This API exposes 5 operations across 4 paths, and defines 36 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://api.x.flatfile.com/v1.

5 operations 4 paths 36 schemas 3 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.x.flatfile.com/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Flatfile Subpackage Events API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (default).

Paths & Operations 5

Across 4 paths, the API surfaces 5 operations — 3 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

subpackage_events 5
GET
/events
List events
list 10 params → 200
POST
/events
Create an event
create 2 params body → 200400404
GET
/events/{eventId}
Get an event
get 3 params → 200
POST
/events/{eventId}/ack
Acknowledge an event
ack 3 params → 200
GET
/subscription
Get subscription credentials
get-event-token 4 params → 200400404

Schemas 36

The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are type_events_Context (24 properties), type_events_CreateEventConfig (11 properties), type_spaces_EventToken (4 properties), type_events_Progress (3 properties). Each schema is shown below with its type and property counts.

type_commons_SnapshotId
string
Snapshot ID
type_commons_CommitId
string
Commit ID
type_commons_WorkbookId
string
Workbook ID
type_commons_DocumentId
string
Document ID
type_events_Domain
string
The domain of the event
type_events_EventResponse
object
1 property 1 required
type_events_Progress
object
The progress of the event within a collection of iterable events
3 properties
type_commons_FileId
string
File ID
type_commons_AppId
string
App ID
type_commons_SheetId
string
Sheet ID
type_commons_ActionId
string
Action ID
type_commons_SuccessData
object
1 property 1 required
type_commons_ThreadId
string
Thread ID
type_commons_Success
object
Informs whether or not a request was successful
1 property
type_spaces_EventTokenResponse
object
1 property 1 required
type_events_ListAllEventsResponse
object
1 property 1 required
type_commons_ProgramId
string
Mapping Program ID
type_events_SheetSlug
string
Sheet Slug
type_commons_EventId
string
Event ID
type_commons_AccountId
string
Account ID
type_events_Event
An event that tracks an activity within an environment
type_events_ActionName
string
Name of an action
type_events_CreateEventConfig
object
Properties used to create a new event
11 properties 4 required
type_commons_EnvironmentId
string
Environment ID
type_commons_VersionId
string
Version ID
type_commons_SpaceId
string
Space ID
type_events_EventAttributes
object
The attributes of the event
2 properties
type_events_EventContextSlugs
object
3 properties
type_commons_Errors
object
1 property 1 required
type_spaces_EventToken
object
Properties used to allow users to connect to the event bus
4 properties
type_commons_DataClipId
string
Data Clip ID
type_commons_JobId
string
Pipeline Job ID
type_events_Context
object
The context of the event
24 properties 2 required
type_commons_Error
object
2 properties 1 required
type_events_Origin
object
The origin resource of the event
2 properties
type_events_EventTopic
string
The topic of the event

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

flatfile-subpackage-events-api-openapi.yml Raw ↑

Other APIs Flatfile publishes across the network.

Flatfile Subpackage Accounts API
Flatfile Subpackage Actions API
Flatfile Subpackage Agent Exports API
Flatfile Subpackage Agents API
Flatfile Subpackage Apps API
Flatfile Subpackage Assistant API
Flatfile Subpackage Auth API
Flatfile Subpackage Canvas Areas API
Flatfile Subpackage Commits API
Flatfile Subpackage Data Clips API
Flatfile Subpackage Data Retention Policies API
Flatfile Subpackage Documents API
Where this information came from

This is an independent, third-party profile of Flatfile Subpackage Events API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.