Skip to main content
Workflow Tasks Return API

The API is used to return workflow tasks.

Updated over 4 months ago

What is the Workflow Tasks Return API?

The API is used to return workflow tasks.


API Calling

The API is used to return workflow tasks.

Request Frequency: 20 times per second

Request Method: POST

Request Parameters:

Parameter

Required

Type

Description

username

Yes

String

It refers to the User No. in Contacts.

instance_id

Yes

String

Instance ID, the same as data_id

task_id

Yes

String

Task ID (should correspond with the username)

flow_id

No

Number

Nodes to return to:

  • Nodes within specified range: The flow_id needs to be set.

  • Previous node: There is no need to set the flow_id. Even if the flow_id is set, the workflow will not return to the specified node.

comment

No

String

Approval comment

Request Example:

{
    "username":"david",
    "instance_id": "6358af7c1f4eab0007704076",
    "task_id":"6358af8446f8db00072d6121",
    "flow_id":1
}

Response Parameters:

Parameter

Type

Description

status

String

success: indicating that the API call is successful

failure: Indicating that the API call failed (with the error code and its description)

code

Number

Error code

message

String

Description of return code

Sample Response:

Success Response Sample

{
    "status": "success"
}


I have finished reading. 🏆

👉I can't wait to SET THE API.

👉I need more HELP in Discord Forum.

Did this answer your question?