Create a job

POST

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

trigger"manual" or "immediate"Optional

Allowed values: manualimmediate

the type of trigger to use for this job

statusenumOptional

the status of the job

progressintegerOptional

the progress of the job. Whole number between 0 and 100

fileIdstringOptional

File ID

modeenumOptional

Allowed values: foregroundbackgroundtoolbarBlocking

the mode of the job

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.

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

partExecution"sequential" or "parallel"Optional

Allowed values: sequentialparallel

The execution mode for this part of the job

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

configobjectOptionalDeprecated

Response

This endpoint returns an object

dataobject

A single unit of work that will execute asynchronously

POST

1 curl -X POST https://api.x.flatfile.com/v1/jobs \
2      -H "X-Disable-Hooks: true" \
3      -H "Authorization: Bearer <token>" \
4      -H "Content-Type: application/json" \
5      -d '{
6   "type": "workbook",
7   "operation": "submitAction",
8   "source": "us_wb_YOUR_ID"
9 }'

200Successful

1 {
2   "data": {
3     "id": "us_jb_YOUR_ID",
4     "createdAt": "2023-10-30T20:04:28.556Z",
5     "updatedAt": "2023-10-30T20:04:32.075Z",
6     "startedAt": "2023-10-30T20:04:29.453Z",
7     "finishedAt": "2023-10-30T20:04:32.074Z",
8     "environmentId": "us_env_YOUR_ID",
9     "type": "workbook",
10     "operation": "submitAction",
11     "source": "us_wb_YOUR_ID",
12     "destination": "us_wb_YOUR_ID",
13     "config": {},
14     "trigger": "immediate",
15     "status": "complete",
16     "progress": 100,
17     "fileId": "us_fl_YOUR_ID",
18     "mode": "foreground",
19     "input": {},
20     "subject": {
21       "id": "us_wb_YOUR_ID",
22       "type": "resource"
23     },
24     "outcome": {
25       "message": "Data was successfully submitted to Webhook.site. Go check it out at https://example.site/example."
26     },
27     "info": "Starting job to submit action to webhook.site",
28     "managed": true
29   }
30 }

Built with

1	curl -X POST https://api.x.flatfile.com/v1/jobs \
2	-H "X-Disable-Hooks: true" \
3	-H "Authorization: Bearer <token>" \
4	-H "Content-Type: application/json" \
5	-d '{
6	"type": "workbook",
7	"operation": "submitAction",
8	"source": "us_wb_YOUR_ID"
9	}'

1	{
2	"data": {
3	"id": "us_jb_YOUR_ID",
4	"createdAt": "2023-10-30T20:04:28.556Z",
5	"updatedAt": "2023-10-30T20:04:32.075Z",
6	"startedAt": "2023-10-30T20:04:29.453Z",
7	"finishedAt": "2023-10-30T20:04:32.074Z",
8	"environmentId": "us_env_YOUR_ID",
9	"type": "workbook",
10	"operation": "submitAction",
11	"source": "us_wb_YOUR_ID",
12	"destination": "us_wb_YOUR_ID",
13	"config": {},
14	"trigger": "immediate",
15	"status": "complete",
16	"progress": 100,
17	"fileId": "us_fl_YOUR_ID",
18	"mode": "foreground",
19	"input": {},
20	"subject": {
21	"id": "us_wb_YOUR_ID",
22	"type": "resource"
23	},
24	"outcome": {
25	"message": "Data was successfully submitted to Webhook.site. Go check it out at https://example.site/example."
26	},
27	"info": "Starting job to submit action to webhook.site",
28	"managed": true
29	}
30	}