Acknowledge a job

POST

Acknowledge a job and return the job

Path parameters

jobIdstringRequired

ID of job to return

Request

This endpoint expects an optional object.

infostringOptional

progressintegerOptional

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

estimatedCompletionAtdatetimeOptional

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/us_jb_YOUR_ID/ack \
2      -H "X-Disable-Hooks: true" \
3      -H "Authorization: Bearer <token>" \
4      -H "Content-Type: application/json" \
5      -d '{
6   "info": "Acknowledged by user",
7   "progress": 100,
8   "estimatedCompletionAt": "2023-10-30T20:04:32.074Z"
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/us_jb_YOUR_ID/ack \
2	-H "X-Disable-Hooks: true" \
3	-H "Authorization: Bearer <token>" \
4	-H "Content-Type: application/json" \
5	-d '{
6	"info": "Acknowledged by user",
7	"progress": 100,
8	"estimatedCompletionAt": "2023-10-30T20:04:32.074Z"
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	}