Workflows

Get all workflows

get

Authorizations

Query parameters

startnumberOptional

The page No

Example: 0

limitnumber · min: 1 · max: 50Optional

The Page Size

Example: 10

Header parameters

X-TexAu-ContextstringRequired

Pass orgUserId and workspaceId as ‘{"orgUserId":"123","workspaceId":"123"}’

Responses

get

HTTPcURLJavaScriptPython

GET /api/v1/public/workflows HTTP/1.1
Host: 
Authorization: Bearer JWT
X-TexAu-Context: text
Accept: */*

{
  "success": true,
  "message": "Workflows fetched successfully",
  "total": 1,
  "data": [
    {
      "id": "The Workflow ID",
      "name": "The Workflow name"
    }
  ]
}

Get workflow by ID

Get workflowId from the response of the above API.

get

Authorizations

Header parameters

X-TexAu-ContextstringRequired

Pass orgUserId and workspaceId as ‘{"orgUserId":"123","workspaceId":"123"}’

Responses

get

HTTPcURLJavaScriptPython

GET /api/v1/public/workflows/{workflowId} HTTP/1.1
Host: 
Authorization: Bearer JWT
X-TexAu-Context: text
Accept: */*

{
  "success": true,
  "message": "Workflow fetched successfully",
  "data": {
    "id": "The Workflow ID",
    "name": "The Workflow name",
    "description": "The Workflow description",
    "isScheduled": false,
    "inputSource": "direct-input"
  }
}

Pause Workflow

This API will pause the workflow, which means all scheduled executions will be canceled.

Get workflowId from the response of the above API.

post

Authorizations

Header parameters

X-TexAu-ContextstringRequired

Pass orgUserId and workspaceId as ‘{"orgUserId":"123","workspaceId":"123"}’

Responses

post

HTTPcURLJavaScriptPython

POST /api/v1/public/workflows/{workflowId}/pause HTTP/1.1
Host: 
Authorization: Bearer JWT
X-TexAu-Context: text
Accept: */*

{
  "success": true,
  "message": "text",
  "data": {
    "workflowId": "text",
    "isActive": true,
    "isInternalSchedule": true,
    "isScheduled": true,
    "isJobAddedOnQueue": true
  }
}

Get workflow nodes by workflow ID

This API will give you a list of all nodes in the workflow.

Get workflowId from the response of the above API.

get

Authorizations

Header parameters

X-TexAu-ContextstringRequired

Pass orgUserId and workspaceId as ‘{"orgUserId":"123","workspaceId":"123"}’

Responses

get

HTTPcURLJavaScriptPython

GET /api/v1/public/workflows/{workflowId}/nodes HTTP/1.1
Host: 
Authorization: Bearer JWT
X-TexAu-Context: text
Accept: */*

{
  "success": true,
  "message": "Workflow nodes fetched successfully",
  "total": 1,
  "data": [
    {
      "id": "The workflow node ID",
      "label": "The workflow node label",
      "nextNode": "The next node ID",
      "previousNode": "The previous node ID",
      "connectedAccountId": "The social account ID",
      "inputs": "The inputs for this node"
    }
  ]
}