Example0

Bad Request

Not Found

Forbidden

Agent Response

Error Response

Nightly Data Loads

My Document 1

string

Updated Title

NewFileName

Your Name Updated

Assign mapping rule

My Secret

New Sheet Name

My First Workbook

My Updated Worbook

John Smith

My View

My Updated Workbook

accounts

actions

agents

apps

assistant

commits

data-retention-policies

documents

entitlements

environments

events

files

guests

jobs

mapping

records

roles

secrets

sheets

snapshots

spaces

users

versions

views

workbooks

Account

AccountPatch

AccountResponse

ActionResponse

Actions

ActionsResponse

Agent

AgentConfig

AgentLog

AgentResponse

AgentVersion

AgentVersionResponse

Compiler

DetailedAgentLog

Execution

GetAgentLogsResponse

GetDetailedAgentLogResponse

GetDetailedAgentLogsResponse

GetExecutionsResponse

ListAgentVersionsResponse

ListAgentsResponse

AppCreate

AppPatch

AppResponse

AppType

AppsResponse

ConstraintCreate

ConstraintResource

ConstraintResponse

ConstraintUpdate

ConstraintsResponse

SuccessResponse

Prompt

PromptCreate

PromptPatch

PromptResponse

PromptTypeEnum

PromptTypeQueryEnum

PromptsResponse

Commit

CommitResponse

ListCommitsResponse

APIAction

AccountId

Action

ActionConstraint

ActionConstraintHasAllValid

ActionConstraintHasData

ActionConstraintHasSelection

ActionId

ActionMessage

ActionMessageType

ActionMode

ActionMount

ActionMountDocument

ActionMountField

ActionMountFile

ActionMountSheet

ActionMountWorkbook

ActionSchedule

ActionUpdate

ActionWithoutLabel

ActorIdUnion

ActorRoleId

AgentId

AgentVersionId

AppId

CommitId

ConstraintId

DataRetentionPolicyId

DocumentId

EnvironmentId

Error

Errors

EventId

FamilyId

FileId

Filter

FilterField

Guardrail

GuestId

Guide

InputConfig

InputConstraint

InputConstraintType

InputEnumPropertyOption

InputField

InputForm

InputFormType

JSONPathString

JobId

MappingId

PageNumber

PageSize

Pagination

ProgramId

PromptId

RecordId

RoleId

SearchField

SearchValue

SecretId

SheetId

SnapshotId

SortDirection

SortField

SpaceConfigId

SpaceId

Success

SuccessData

SuccessQueryParameter

UserId

VersionId

ViewId

WorkbookId

Resolve

ResolveTo

ResolveType

DataRetentionPolicy

DataRetentionPolicyConfig

DataRetentionPolicyEnum

DataRetentionPolicyResponse

ListDataRetentionPoliciesResponse

Document

DocumentConfig

DocumentResponse

ListDocumentsResponse

Entitlement

ListEntitlementsResponse

Environment

EnvironmentConfigCreate

EnvironmentConfigUpdate

EnvironmentResponse

GuestAuthenticationEnum

ListEnvironmentsResponse

ActionName

BaseEvent

Context

CreateEventConfig

Domain

Event

EventAttributes

EventContextSlugs

EventResponse

EventTopic

GenericEvent

ListAllEventsResponse

Origin

Progress

SheetSlug

File

FileOrigin

FileResponse

ListFilesResponse

Mode

ModelFileStatusEnum

Flatfile | API Reference

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	}

Get an event

Path parameters

Headers

Response

1	curl https://api.x.flatfile.com/v1/events/us_evt_YOUR_ID \
2	-H "X-Disable-Hooks: true" \
3	-H "Authorization: Bearer <token>"