For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
CommunityCreate AccountSign in
  • Overview
    • Welcome
    • Authentication
    • Using Environments
  • API Reference
      • GETList jobs
      • POSTCreate a job
      • GETGet a job
      • PATCHUpdate a job
      • DELDelete a job
      • POSTExecute a job
      • GETGet a job's execution plan
      • PUTReplace a job's plan
      • PATCHUpdate a job's plan
      • POSTAcknowledge a job
      • POSTAcknowledge a job outcome
      • POSTComplete a job
      • POSTFail a job
      • POSTCancel a job
      • POSTRetry a failed job
      • POSTPreview a mutation
      • POSTSplit a job
LogoLogo
LogoLogo
CommunityCreate AccountSign in
API ReferenceJobs

Create a job

POST
https://api.x.flatfile.com/v1/jobs
POST
/v1/jobs
$curl -X POST https://api.x.flatfile.com/v1/jobs \
>     -H "X-Disable-Hooks: true" \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "type": "workbook",
>  "operation": "submitAction",
>  "source": "us_wb_YOUR_ID"
>}'
200Example0
1{
2  "data": {
3    "createdAt": "2023-10-30T20:04:28.556Z",
4    "createdBy": "us_usr_YOUR_ID",
5    "id": "us_jb_YOUR_ID",
6    "operation": "submitAction",
7    "source": "us_wb_YOUR_ID",
8    "type": "workbook",
9    "updatedAt": "2023-10-30T20:04:32.075Z",
10    "config": {},
11    "destination": "us_wb_YOUR_ID",
12    "environmentId": "us_env_YOUR_ID",
13    "fileId": "us_fl_YOUR_ID",
14    "finishedAt": "2023-10-30T20:04:32.074Z",
15    "info": "Starting job to submit action to webhook.site",
16    "input": {},
17    "managed": true,
18    "mode": "foreground",
19    "outcome": {
20      "message": "Data was successfully submitted to Webhook.site. Go check it out at https://example.site/example."
21    },
22    "progress": 100,
23    "spaceId": "us_sp_YOUR_ID",
24    "startedAt": "2023-10-30T20:04:29.453Z",
25    "status": "complete",
26    "subject": {
27      "type": "resource",
28      "id": "us_wb_YOUR_ID"
29    },
30    "trigger": "immediate"
31  }
32}
Was this page helpful?
Previous

Get a job

Next
Built with

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

X-Disable-Hooks"true"Required

Request

This endpoint expects an object.
typeenumRequired
The type of job
operationstringRequired
the type of operation to perform on the data. For example, "export".
sourcestringRequired
The id of a file, workbook, sheet, or app
destinationstringOptional
The id of the workbook where extracted file data will be sent
configobjectOptional
triggerenumOptional
the type of trigger to use for this job
Allowed values:
statusenumOptional
the status of the job
progressintegerOptional
the progress of the job. Whole number between 0 and 100
fileIdstringOptional
File ID
modeenumOptional
the mode of the job
Allowed values:
inputmap from strings to anyOptional
Input parameters for this job type.
subjectobjectOptional
Subject parameters for this job type.
outcomemap from strings to anyOptional
Outcome summary of job.
resultmap from strings to anyOptional
Information computed during job execution can be stored here
infostringOptional
Current status of job in text
managedbooleanOptional
Indicates if Flatfile is managing the control flow of this job or if it is being manually tracked.
environmentIdstringOptional
The id of the environment this job belongs to
partintegerOptional
The part number of this job
partDatamap from strings to anyOptional
The data for this part of the job
partExecutionenumOptional
The execution mode for this part of the job
Allowed values:
parentIdstringOptional
The id of the parent job
predecessorIdslist of stringsOptional
The ids of the jobs that must complete before this job can start
metadatamap from strings to anyOptional
Additional metadata for the job

Response

This endpoint returns an object.
dataobject
A single unit of work that will execute asynchronously