Workflow API

Workflow related endpoints, from the Trigger to the Results

triggerworkflow/{workflow_id}/{workflow_version}

POST https://api.looply.io/v1/workflows/triggerworkflow/{workflow_id}/{workflow_version}

You can supply any (although not required) JSON stringified body to this request. This will return a looply_execution_id which can be used to get more information on this Looply Workflow.

Path Parameters

Name	Type	Description
workflow_id*	String	id of the workflow
workflow_version	String	version of the workflow

Headers

Name	Type	Description
x-api-key*	String	Your API Key

200: OK Success Response

{
	"message": "success",
	"looply_execution_id": "****"
}

403: Forbidden Incorrect or No API Key Supplied

500: Internal Server Error Server side error

Serverside issue with this endpoint

400: Bad Request Missing Workflow Id

{action}/{process_id}

POST https://api.looply.io/v1/workflows/{action}/{process_id}

Manually resume workflows depending on the process_id supplied. Resuming a workflow can contain any JSON stringified body payload, source is the only protected attribute.

More actions to come...

Path Parameters

Name	Type	Description
action*	String	resumeworkflow is currently the only action available
process_id*	String	Process ID supplied to the triggerworkflow endpoint or use the looply_execution_id if you did not supply one.

Headers

Name	Type	Description
x-api-key*	String	Your API Key

Request Body

Name	Type	Description
source	String	Allowed sources TEAMS | SAP

200: OK Success

404: Not Found Workflow Process/Execution not found

403: Forbidden Incorrect or No API Key Supplied

409: Conflict This process is not waiting to be resumed

500: Internal Server Error Server side error.

Serverside issue with this endpoint

toggleScheduledWorkflow

POST https://api.looply.io/v1/workflows/toggleScheduledWorkflow

Pause and resume scheduled workflows.

Headers

Name	Type	Description
x-api-key	String	Your API Key

Request Body

Name	Type	Description
workflow_id	String	id of the workflow
workflow_version	Number	version of the workflow
action	String	PAUSE or PLAY

200: OK Success

Example Payload:

{
	"message": "success",
	"workflow_id": "be9439c2-16b9-4de2-bb1a-9154b85af065",
	"workflow_version": 1,
	"status": "ACTIVE" // or "PAUSED"
}

400: Bad Request Incorrect input body provided

409: Conflict Wrong Action Provided.

500: Internal Server Error Server side error.

getWorkflowExecutionById

GET https://api.looply.io/v1/workflows/getWorkflowExecutionById

Returns the current state and logs for the workflow execution.

Query Parameters

Name	Type	Description
workflow_id*	String	Id of the workflow
workflow_execution_id*	String	Id for the workflow execution

Headers

Name	Type	Description
x-api-key*	String	Your API Key

200: OK Success

Example Payload:

{
	"message": "success",
	"item": {
		"workflow_current_state": "State Name",
		"organization_id": "****",
		"workflow_execution_id": "****",
		"modified_by": null,
		"workflow_version": 1,
		"workflow_event_log": {
			// trimmed down logs
		},
		"workflow_id": "****",
		"workflow_input_payload": {
			// combined input payload
		},
		"workflow_output_payload": {
			// combined output payload
		},
		"workflow_trigger_type": "REQUEST",
		"workspace_id": "****",
		"created_on": 1697641835712,
		"condensed_logs": {
            		// input/output for each step. Condensed
        	},
		"workflow_details": { 
			// structure of the workflow - connections and steps
		}
    }

400: Bad Request Incorrect or missing Query Parameters

404: Not Found Execution does not exist

500: Internal Server Error Server side Error

401: Unauthorized You don't have access to this execution.

403: Forbidden Incorrect or No API Key Supplied

getWorkflowExecutionHistory

GET https://api.looply.io/v1/workflows/getWorkflowExecutionHistory

Returns a list of workflow executions. Will return a lastKey attribute. Use this to get the next page of data.

Limit can be added to the request, 30 is the max.

Query Parameters

Name	Type	Description
workflow_id*	String	id of the workflow
limit	String	Number of items to return per page. Default 20
workflow_execution_id	String	Pagination Key from the lastKey attribute.

Headers

Name	Type	Description
x-api-key*	String	Your API Key

200: OK Success

Example Payload:

{
	"message": "success",
	"count": 20,
	"items": [
		{
			"workflow_id": "****",
			"workflow_current_state": "wait_for_response_state",
			"modified_on": 1697454831391,
			"organization_id": "****",
			"workflow_execution_id": "****",
			"modified_by": null,
			"workflow_version": 1,
			"workflow_event_log": {
				// trimmed down logs
			},
			"workflow_trigger_type": "REQUEST",
			"workspace_id": "****",
			"created_on": 1697454828765,
			"workflow_details": {
				"workflow_name": "Workflow name"
			}
		}
		
	],
	"lastKey": {
		"workflow_id": "****",
		"workflow_execution_id": "****"
	}
}

400: Bad Request Incorrect or missing Query Parameters

401: Unauthorized You don't have access to this workflow's executions.

403: Forbidden Incorrect or No API Key Supplied

500: Internal Server Error Server side error.

getOrganizationExecutions

GET https://api.looply.io/v1/workflows/getOrganizationExecutions

Returns a list of all the workflow executions for an organization. Will return a lastKey attribute. Use this to get the next page of data.

Limit can be added to the request, 30 is the max.

Query Parameters

Name	Type	Description
limit	String	Number of items to return per page. Default 20
workflow_id	String	Pagination Key from the lastKey attribute
workflow_execution_id	String	Pagination Key from the lastKey attribute

200: OK Success

Example Payload:

{
	"message": "success",
	"count": 20,
	"items": [
		{
			"workflow_id": "****",
			"workflow_current_state": "wait_for_response_state",
			"modified_on": 1697454831391,
			"organization_id": "****",
			"workflow_execution_id": "****",
			"modified_by": null,
			"workflow_version": 1,
			"workflow_event_log": {
				// event log
			},
			"workflow_trigger_type": "REQUEST",
			"workspace_id": "****",
			"created_on": 1697454828765,
			"workflow_details": {
				"workflow_name": "Workflow name"
			}
		},
		
	],
	"lastKey": {
		"workflow_id": "****",
		"workflow_execution_id": "****"
	}
}

403: Forbidden Incorrect or No API Key Supplied

500: Internal Server Error Server side error.

getWorkflowById

GET https://api.looply.io/v1/workflows/getWorkflowById

Returns all data for a Looply Workflow

Query Parameters

Name	Type	Description
workflow_id*	String	Id for the workflow
workflow_version*	String	Version of the workflow

Headers

Name	Type	Description
x-api-key*	String	Your API Key

200: OK Success

Example Payload:

{
  "message": "success",
  "item": {
    "organization_id": "****",
    "workflow_integrations": {
      // integrations configured for this workflow - e.g. SAP profile
    },
    "workflow_name": "****",
    "created_by": "test-user",
    "workflow_status_version": "DRAFT_1",
    "modified_by": null,
    "workflow_version": 1,
    "workflow_steps": [
      // states within the workflow
    ],
    "workflow_id": "****",
    "modified_on": 1697642922168,
    "workflow_connections": [
      // connections between all the workflow states
    ],
    "workflow_status": "DRAFT",
    "latest": "true",
    "workspace_id": "****",
    "created_on": 1695136500202,
    "workflow_schema": {
      // workflow schema
    }
  }
}

400: Bad Request Incorrect or missing Query Parameters

401: Unauthorized You don't have access to this workflow.

403: Forbidden Incorrect or No API Key Supplied

404: Not Found Execution does not exist

500: Internal Server Error Server side Error

getOrganizationWorkflows

GET https://api.looply.io/v1/workflows/getOrganizationWorkflows

Returns a list organization workflows. Will return a lastKey attribute. Use this to get the next page of data.

Limit can be added to the request, 30 is the max.

Query Parameters

Name	Type	Description
limit	String	Number of items to return per page. Default 20
workflow_id	String	Pagination Key from the lastKey attribute.
workflow_version	String	Pagination Key from the lastKey attribute.

Headers

Name	Type	Description
x-api-key*	String	Your API Key

200: OK Success

Example Payload:

{
  "message": "success",
  "count": 20,
  "items": [
    {
      "workflow_id": "****",
      "modified_on": 1693488718083,
      "organization_id": "****",
      "workflow_status": "ACTIVE",
      "latest": "false",
      "workflow_name": "Adaptive Card Workflow",
      "created_by": "****",
      "workflow_status_version": "ACTIVE_3",
      "modified_by": "****",
      "workspace_id": "****",
      "created_on": 1692614072550
    }
  ],
  "lastKey": {
    "organization_id": "****",
    "workflow_id": "****",
    "workflow_version": 1
  }
}

500: Internal Server Error Server side Error

getWorkflowSchemaById

GET https://api.looply.io/v1/workflows/getWorkflowSchemaById

Returns the data schema for a workflow

Query Parameters

Name	Type	Description
workflow_id*	String	Id of the workflow
workflow_version*	String	Version of the workflow

Headers

Name	Type	Description
x-api-key*	String	Your API Key

200: OK Success

Example Payload:

{
  "message": "success",
  "item": {
    "workflow_id": "****",
    "modified_on": 1697642922168,
    "created_by": "test-user",
    "workflow_mock_payload": {
      // mock payload from a previous execution
    },
    "workflow_schema": {
      // schema for the mock payload
    },
    "modified_by": null,
    "workflow_version": 1,
    "created_on": 1695136500202
  }
}

400: Bad Request Incorrect or missing Query Parameters

401: Unauthorized You don't have access to this execution.

403: Forbidden Incorrect or No API Key Supplied

404: Not Found Execution does not exist

500: Internal Server Error Server side Error