webMethods.io Integration API Reference

Browse the API Reference documentation to build connected applications with webMethods.io Integration APIs.

Overview

webMethods.io Integration provides a robust set of APIs that allow you to programmatically integrate your own applications with webMethods.io Integration, in a simple and secure manner. webMethods.io Integration APIs permit access to webMethods.io Integration functionalities and data in an authorized way to accomplish integration of systems and applications. Our APIs are based on REST architectural style and can be communicated using HTTP requests.

Authentication

webMethods.io Integration uses the HTTP basic authentication method to authenticate each HTTP request made to the API. With this authentication mechanism, webMethods.io Integration verifies the identity of API consumers and ensures that they have the necessary permission to access relevant data.

You can pass your tenant login credentials to authenticate yourself while making a request to the API in a REST client application. webMethods.io Integration verifies the supplied credentials contained in an Authentication header against the list of registered tenant users and then allows the users to access the relevant data.

webMethods.io Integration APIs

webMethods.io Integration APIs are categorized into the following domains:

Domain Used for …
Workflow APIs Exporting, importing, deleting, and executing a workflow
FlowService APIs Exporting, importing, deleting, and executing a FlowService
Project APIs Creating, updating, deleting, and retrieving a project
Retrieving a list of projects
Retrieving a list of project assets
Publishing and deploying a project
Creating, deleting, updating, and retrieving a project parameter
Listing project parameters
Role Management APIs Creating a role for a particular tenant
Updating an existing role
Deleting a role
Retrieving details of a particular role
Listing a collection of roles associated with a particular tenant
User Management APIs Retrieving a list of users associated with a particular tenant
Assigning roles to a user
Themes APIs Creating a theme
Managing themes
Retrieving theme details
Listing themes
Retrieving default values for the current theme
Webhook APIs Retrieving details of workflows that are webhook-enabled
Regenerating webhook URL for an existing workflow in a particular tenant
Adding an authentication mechanism to a webhook in a particular tenant
Recipes APIs Creating and deleting a recipe
Retrieving recipe details
Retrieving all recipes for a tenant

Deprecated URLs

The URL syntax of all public APIs that were introduced in Release 10.11 are deprecated and will become obsolete in a later release. Currently, deprecated URLs are functional and supported only for backward compatibility.

Old URL Format (Deprecated): <domain>/enterprise/v1/rest/...

New URL Format: <domain>/apis/v1/rest/...

The APIs listed below have been deprecated:

APIs Deprecated URL New URL
Workflow API - Exporting a workflow <domain>/enterprise/v1/rest/projects/:project/workflows/:workflow/export <domain>/apis/v1/rest/projects/:project/workflows/:workflow/export
Workflow API - Importing a workflow <domain>/enterprise/v1/rest/projects/:project/workflow-import <domain>/apis/v1/rest/projects/:project/workflow-import
Workflow API - Deleting a workflow <domain>/enterprise/v1/rest/projects/:project/workflows/:workflow <domain>/apis/v1/rest/projects/:project/workflows/:workflow
Workflow API - Executing a workflow <domain>/enterprise/v1/rest/projects/:project/workflows/:workflow/run <domain>/apis/v1/rest/projects/:project/workflows/:workflow/run
Workflow API - Retrieving workflow execution status <domain>/enterprise/v1/rest/projects/:project/workflow-run/:run_id <domain>/apis/v1/rest/projects/:project/workflow-run/:run_id
FlowService API - Exporting a FlowService <domain>/enterprise/v1/rest/projects/:project/flows/:flow/export <domain>/apis/v1/rest/projects/:project/flows/:flow/export
FlowService API - Importing a FlowService <domain>/enterprise/v1/rest/projects/:project/flow-import <domain>/apis/v1/rest/projects/:project/flow-import
FlowService API - Deleting a FlowService <domain>/enterprise/v1/rest/projects/:project/flows/:flow <domain>/apis/v1/rest/projects/:project/flows/:flow
FlowService API - Executing a FlowService <domain>/enterprise/v1/rest/projects/:project/flows/:flow/run <domain>/apis/v1/rest/projects/:project/flows/:flow/run
Project API - Creating a project <domain>/enterprise/v1/rest/projects <domain>/apis/v1/rest/projects
Project API - Updating a project <domain>/enterprise/v1/rest/projects <domain>/apis/v1/rest/projects
Project API - Deleting a project <domain>/enterprise/v1/rest/projects/project <domain>/apis/v1/rest/projects/project
Project API - Retrieving a project <domain>/enterprise/v1/rest/projects/project <domain>/apis/v1/rest/projects/project
Project API - Retrieving a list of projects <domain>/enterprise/v1/rest/projects <domain>/apis/v1/rest/projects

Note: Currently, both the deprecated URL and the new URL are supported for the listed public APIs. It is strongly recommended that you review the current deployment and change the implementation to utilize the new URL format provided.

Workflow APIs

Export

Allows you to export a workflow and all its dependencies. The exported data will be downloaded as a zip file to your local machine.

Steps:

  1. In a REST client platform, add the authentication details of the tenant from where you want to export a workflow.

    Headers: 
    {
        Authorization: BasicAuth
    }
    Body: 
    {
        description: <description>,
        name: <workflow_name>
    }
  2. Perform a POST request at the URL of the workflow that you want to export.

    URL Syntax (Deprecated): <domain>/enterprise/v1/rest/projects/:project/workflows/:workflow/export

    Use this instead,

    URL Syntax: <domain>/apis/v1/rest/projects/:project/workflows/:workflow/export

    In this URL request, /:project is the name of the project associated with the workflow you want to export and /:workflow is the UID of the workflow you want to export.

    Method: POST

Output:

If the request is successful, you will receive the HTTP 200 OK success status response code.

{
output: 
	{
		download_link: <download_link>,
		valid_till: <valid_till>
	}
}

Note: The value in valid_till indicates the validity period for downloading the link.

Import

Allows you to import a workflow and all its dependencies into a particular project. Whenever you make a request, a new workflow is created even though the same zip file is uploaded.

Steps:

  1. In a REST client platform, add the required details of the tenant where you want to import a workflow.

    Headers: 
    {             
    Authorization: BasicAuth
    }
        
    domain => https:/<tenant_name>.dev-int-aws-us.webmethods.io
        
    Body: 
    {
    recipe: <zip_file_binary>
    }
  2. Perform a POST request at the URL of the workflow.

    URL Syntax (Deprecated): <domain>/enterprise/v1/rest/projects/:project/workflow-import

    Use this instead,

    URL Syntax: <domain>/apis/v1/rest/projects/:project/workflow-import

    In this URL request, /:project is the name of the project where you want to import.

    Method: POST

Output:

If the request is successful, you will receive the HTTP 200 OK success status response code.

{
output: 
	{
		name: <workflow_name>,
		description: <workflow_description>,
		refid: <workflow_refid>,
		sid: <workflow_sid>,
		uid: <workflow_uid>,
		project_uid: <workflow_project_uid>,
		tenant_uid: <workflow_tenant_uid>
	}
}

Delete

Allows you to delete a workflow and all its dependencies from a particular project.

Steps:

  1. In a REST client platform, add the authentication details of the tenant associated with the workflow that you want to delete.

    Headers: 
    {             
        Authorization: BasicAuth
    }
  2. Perform a DELETE request at the URL of the workflow.

    URL Syntax (Deprecated): <domain>/enterprise/v1/rest/projects/:project/workflows/:workflow

    Use this instead,

    URL Syntax: <domain>/apis/v1/rest/projects/:project/workflows/:workflow

    In this URL request, /:project is the name of the project associated with the workflow you want to delete and /:workflow is the UID of the workflow you want to delete.

    Method: DELETE

Output:

If the request is successful, you will receive the HTTP 200 OK success status response code.

{
 output: 
	{
	message: "Object deleted successfully."
	}
}

Execute

Allows you to execute a particular workflow.

Steps:

  1. In a REST client platform, add the authentication details of the tenant associated with the workflow you want to execute.

    Headers: 
    {             
    Authorization: BasicAuth
    }
  2. Perform a POST request at the URL of the workflow you want to execute.

    URL Syntax (Deprecated): <domain>/enterprise/v1/rest/projects/:project/workflows/:workflow/run

    Use this instead,

    URL Syntax: <domain>/apis/v1/rest/projects/:project/workflows/:workflow/run

    In this URL request, /:project is the name of the project associated with the workflow you want to execute and /:workflow is the UID of the workflow you want to execute.

    Method: POST

Output:

If the request is successful, you will receive the HTTP 200 OK success status response code.

{
 output : 
	{
	run_id: <run_id>,
	response: "Workflow enqueue successfully.",
	status: "<current_stauts_of_workflow_run>",
	workflow_uid: <workflow_uid>,
	project_uid: <workflow_project_uid>,
	tenant_uid: <workflow_tenant_uid>
    }
}   

Get Workflow Execution Status

Allows you to check the current status of the workflow execution.

Steps:

  1. In a REST client platform, add the authentication details of the tenant associated with the workflow of which execution status you want to retrieve.

    Headers: 
    {             
        Authorization: BasicAuth
    }
  2. Perform a GET request at the URL of the workflow.

    URL Syntax (Deprecated): <domain>/enterprise/v1/rest/projects/:project/workflow-run/:run_id

    Use this instead,

    URL Syntax: <domain>/apis/v1/rest/projects/:project/workflow-run/:run_id

    In this URL request, /:project is the name of the project associated with the workflow.

    Method: GET

Output:

If the request is successful, you will receive the HTTP 200 OK success status response code.

{
	output:
		{
		"objects":
				[{
				"run_id": <run_id>,
				"status": "<current_status_of_workflow_run>"
				},
				{
				.
				.
				}
				]
		}
}

FlowService APIs

Export

Allows you to export a FlowService and all its dependencies. The exported data will be downloaded as a zip file to your local machine.

Steps:

  1. In a REST client platform, add the authentication details of the tenant from where you want to export a FlowService.

    Headers: 
    {
        Authorization: BasicAuth
    }
  2. Perform a POST request at the URL of the FlowService that you want to export.

    URL Syntax (Deprecated): <domain>/enterprise/v1/rest/projects/:project/flows/:flow/export

    Use this instead,

    URL Syntax: <domain>/apis/v1/rest/projects/:project/flows/:flow/export

    In this URL request, /:project is the name of the project associated with the FlowService you want to export and /:flow is the name of the FlowService you want to export.

    Method: POST

Output:

If the request is successful, you will receive the HTTP 200 OK success status response code.

{
  output : 
	{
	download_link: <download_link>,
	valid_till: <valid_till>
    }
}

Note: The value in valid_till indicates the validity period for downloading the link.

Import

Allows you to import a FlowService and all its dependencies into a particular project. If you import a FlowService with the same name as an existing FlowService in the tenant, then webMethods.io Integration overwrites the existing FlowService. If a FlowService with the same name does not exist, then a new FlowService is created.

Steps:

  1. In a REST client platform, add the required details of the tenant where you want to import a FlowService.

    Headers: 
    {             
     Authorization: BasicAuth
    }
             
    domain => https:/<tenant_name>.dev-int-aws-us.webmethods.io
             
    Body: 
    {
     recipe: <zip_file_binary>
    }
  2. Perform a POST request at the URL of the FlowService.

    URL Syntax (Deprecated): <domain>/enterprise/v1/rest/projects/:project/flow-import

    Use this instead,

    URL Syntax: <domain>/apis/v1/rest/projects/:project/flow-import

    In this URL request, /:project is the name of the project where you want to import the FlowService.

    Method: POST

Output:

If the request is successful, you will receive the HTTP 200 OK success status response code.

{
 output : {
			"name": "<flow_name>",
			"assemblyType": "<assembly_type>",
			"serviceFullName": "<service_FullName>",
			"project_uid": "<project_uid>",
			"tenant_uid": "*<tenant_uid>"
			}
}

Delete

Allows users to delete a FlowService and all its dependencies from a particular project.

Steps:

  1. In a REST client platform, add the authentication details of the tenant associated with the FlowService you want to delete.

    Headers: 
    {             
     Authorization: BasicAuth
    }
  2. Perform a DELETE request at the URL of the FlowService.

    URL Syntax (Deprecated): <domain>/enterprise/v1/rest/projects/:project/flows/:flow

    Use this instead,

    URL Syntax: <domain>/apis/v1/rest/projects/:project/flows/:flow

    In this URL request, /:project is the name of the project associated with the FlowService you want to delete and /:flow is the name of the FlowService you want to delete.

    Method: DELETE

Output:

If the request is successful, you will receive the HTTP 200 OK success status response code.

{
 output: 
	{
	message: "Object deleted successfully."
	}
}

Execute

Allows you to execute a particular FlowService.

Steps:

  1. In a REST client platform, add the authentication details of the tenant associated with the FlowService you want to execute.

    Headers: 
    {             
    Authorization: BasicAuth
    }
  2. Perform a POST request at the URL of the FlowService you want to execute.

    URL Syntax: <domain>/enterprise/v1/rest/projects/:project/flows/:flow/run

    Use this instead,

    URL Syntax: <domain>/apis/v1/rest/projects/:project/flows/:flow/run

    In this URL request, /:project is the name of the project associated with the FlowService you want to execute and /:flow is the name of the FlowService you want to execute.

    Method: POST

Output:

If the request is successful, you will receive the HTTP 200 OK success status response code.

{
output : 
	{
	"contentStream": "<content_stream>",
    "date": "<datetime>"
    }
}

Project APIs

Create

Allows you to create a new project in a particular tenant.

Steps:

  1. In a REST client platform, add the authentication details of the tenant where you want to create a project.

    Headers: 
    {
        Authorization: BasicAuth
    }
    Body: 
    {
        name: <project_name>
    }
  2. Perform a POST request at the URL of the project.

    URL Syntax (Deprecated): <domain>/enterprise/v1/rest/projects

    Use this instead,

    URL Syntax: <domain>/apis/v1/rest/projects

    Method: POST

Output:

If the request is successful, you will receive the HTTP 200 OK success status response code.

{
{
 output : 
		{
		name: <project_name>,
		uid: <project_uid>,
		tenant_uid: <project_tenant_uid>,
		workflow_count: <workflow_count>,
		flowservice_count: <flowservice_count>
		}
}
}    

Update

Allows you to update an existing project.

Steps:

  1. In a REST client platform, add the authentication details of the tenant associated with the project you want to update.

    Headers: 
            {
            Authorization: BasicAuth
            }
    Body: 
            {
            name: <project_name>
            }
  2. Perform a PUT request at the URL of the project.

    URL Syntax (Deprecated): <domain>/enterprise/v1/rest/projects

    Use this instead,

    URL Syntax: <domain>/apis/v1/rest/projects

    Method: PUT

Output:

If the request is successful, you will receive the HTTP 200 OK success status response code.

{
 {
  output : 
		{
		name: <project_name>,
		uid: <project_uid>,
		tenant_uid: <project_tenant_uid>,
		workflow_count: <workflow_count>,
		flowservice_count: <flowservice_count>
		}
 }
}

Delete

Allows you to delete an existing project.

Steps:

  1. In a REST client platform, add the authentication details of the tenant associated with the project you want to delete.

    Headers: 
    {
        Authorization: BasicAuth
    }
  2. Perform a DELETE request at the URL of the project.

    URL Syntax (Deprecated): <domain>/enterprise/v1/rest/projects/project

    Use this instead,

    URL Syntax: <domain>/apis/v1/rest/projects/project

    Method: DELETE

Output:

If the request is successful, you will receive the HTTP 200 OK success status response code.

{
 output: 
		{
		message: "Project deleted successfully."
		}
}

Get a project

Allows you to retrieve a project.

Steps:

  1. In a REST client platform, add the authentication details of the tenant associated with the project you want to retrieve.

    Headers: 
    {
    Authorization: BasicAuth
    }
  2. Perform a GET request at the URL of the project.

    URL Syntax (Deprecated): <domain>/enterprise/v1/rest/projects/project

    Use this instead,

    URL Syntax: <domain>/apis/v1/rest/projects/project

    Method: GET

Output:

If the request is successful, you will receive the HTTP 200 OK success status response code.

{
 output : 
	{
		name: <project_name>,
		uid: <project_uid>,
		tenant_uid: <project_tenant_uid>,
		workflow_count: <workflow_count>,
		flowservice_count: <flowservice_count>
	}
}

Get a list of projects

Allows you to retrieve a list of accessible project.

Steps:

  1. In a REST client platform, add the authentication details of the tenant from where you want to retrieve projects.

    Headers: 
            {
            Authorization: BasicAuth
            }
  2. Perform a GET request at the URL of the project.

    URL Syntax (Deprecated): <domain>/enterprise/v1/rest/projects

    Use this instead,

    URL Syntax: <domain>/apis/v1/rest/projects

    Method: GET

Output:

If the request is successful, you will receive the HTTP 200 OK success status response code.

{
 output : 
		[{
		name: <project_name>,
		uid: <project_uid>,
		tenant_uid: <project_tenant_uid>,
		workflow_count: <workflow_count>,
		flowservice_count: <flowservice_count>
		}]
}

Get a list of project assets

Allows you to retrieve a list of all valid assets for a particular project.

Steps:

  1. In a REST client platform, add the authentication details of the tenant from where you want to retrieve valid assets created in a particular project.

    Headers: 
            {
            Authorization: BasicAuth
            }
  2. Perform a GET request at the URL of the project.

    URL Syntax: <domain>/apis/v1/rest/projects/:project/assets

    In this URL request, /:project is the name of the project from where you want to retrieve assets.

    You can control and filter the output response by using a query parameter. To retrieve additional details of assets created in a specific project, append the query parameter ?complete=true to the end of the URL request. This is an optional parameter and its default value is false.

    Method: GET

Output:

If the request is successful, you will receive the HTTP 200 OK success status response code.

{
output : {
"workflows": [
            "<workflow1_uid>",
            "<workflow2_uid>",
        ],
        "flows": [
            "<flowservice1_name>",
            "<flowservice2_name>",
        ],
        "rest_api": [
            "<rest_api1_name>",
            "<rest_api2_name>",
        ],
        "soap_api": [
            "<soap_api1_name>",
            "<soap_api2_name>",
        ],
        "messaging": [
            "<subscriber1_name>",
            "<subscriber2_name>"
        ]
}
}

Publish a project

Allows you to publish a particular project along with its valid assets to the target tenant.

Note: Single sign-on is not supported.

Steps:

  1. In a REST client platform, add the authentication details of the tenant where you want to publish a project.

    	Headers: {
    			Authorization: BasicAuth
    			}
    	Body: {
            "name":"<publish_name>", 
            "destination_tenant_detail":
    			{
    				"username":"<username>",
    				"password":"<password>",
    				"url":"<target_tenant_url>"
    			},
    			"workflows": 
    				[
    				"<workflow1_uid>",
    				"<workflow2_uid>",
    				],
    			"flows": 
    				[
    				"<flowservice1_name>",
    				"<flowservice2_name>",
    				],
    			"rest_api": 
    				[
    				"<rest_api1_name>",
    				"<rest_api2_name>",
    				],
    			"soap_api": 
    				[
    				"<soap_api1_name>",
    				"<soap_api2_name>",
    				],
    			"messaging": 
    				[
    				"<subscriber1_name>",
    				"<subscriber2_name>"
    				]
    			}
  2. Perform a POST request at the URL of the project.

    URL Syntax: <domain>/apis/v1/rest/projects/:project/publish

    In this URL request, /:project is the name of the project you want to publish.

    Method: POST

Output:

If the request is successful, you will receive the HTTP 200 OK success status response code.

{
	output : 
	{
		"uid": "<deployment_uid>",        
		"name": "<deployment_name>",
		"description": "<deployment_description>",
		"version": "<deployment_version>",
		"project_name": "<project_name>",
		"project_uid": "<project_uid>",
		"tenant_uid": "<tenant_uid>",
		"to_tenant": "<target_tenant_name>"
		"from_tenant": "<source_tenant_name>",
		"contains_asset": 
			{
			"sap_assets": <true || false>,
			"messaging_assets": <true || false>
			}       
	}
}

Deploy a project

Allows you to deploy a project published by another tenant to your tenant.

Steps:

  1. In a REST client platform, add the authentication details of the tenant where you want to deploy a project.

    	Headers: 
    	{
    	Authorization: BasicAuth
    	}
    	Body:
    	{
    	"version":<version_number>*,
    	"new_project_name":<new_project_name>$
    	}
    
    // A field with the asterisk (*) character in the body of the request is a required field. 
    // The dollar ($) character appended to the project name in the body of the request indicates that you are deploying a project for the first time and you already have a project with the same name in the target tenant.
  2. Perform a POST request at the URL of the project.

    URL syntax: <domain>/apis/v1/rest/projects/:project/deploy

    In this URL request, /:project is the name of the project you want to deploy.

    Method: POST

Output:

If the request is successful, you will receive the HTTP 200 OK success status response code.

{
output: 
	{
        "status": "<deployment_status>",
        "messaging_issues": 
		{
		"issues": [<commaseparated_string_arr>],
		"description": "<messaging_issue_desc>"
		}
	}
}

Create a project parameter

Allows you to create a new project parameter.

Steps:

  1. In a REST client platform, add the authentication details of the tenant where you want to create a project parameter.

    Headers: 
    	{
    		Authorization: BasicAuth
    	}
    Body:
    	{   
    		"key": "<param_name>*^",  
    		"value": "<param_value>*",
    		"required": <true || false>*,
    		"isPassword": <true || false>*    
    	}
    	
    //A field with the asterisk (*) character in the body of the request is a required field. 
    //A field with the caret (^) character in the body of the request indicates that the field can only have unique values.
  2. Perform a POST request at the URL of the project.

    URL syntax: <domain>/apis/v1/rest/projects/:project/params

    In this URL request, /:project is the name of the project where you want to create a parameter.

    Method: POST

Output:

If the request is successful, you will receive the HTTP 201 OK success status response code.

{
output: 
	{
		"uid": "<param_uid>",
		"param": 
		{
		"key": "<param_name>",
		"value": "<param_value>",
		"required": <true || false>,
		"isPassword": <true || false>            
		},
		"project_uid": "<project_uid>",
		"tenant_uid": "<tenant_uid>"
	}
}

Update a project parameter

Allows you to update an existing project parameter.

Steps:

  1. In a REST client platform, add the authentication details of the tenant where you want to update a project parameter.

    Headers: 
    	{
    	Authorization: BasicAuth
    	}
    Body:
    	{   
    	"key": "<param_name>*^",
    	"value": "<param_value>*",
    	"required": <true || false>*,
    	"isPassword": <true || false>*    
    	}
    	 
    // A field with the asterisk (*) character in the body of the request is a required field.
    // A field with the caret (^) character in the body of the request indicates that the field can only have unique values.	 
  2. Perform a PUT request at the URL of the project.

    URL Syntax: <domain>/apis/v1/rest/projects/:project/params/param_uid

    In this URL request, /:project is the name of the project where you want to update a parameter and param_uid is the ID of the parameter you want to update.

    Method: PUT

Output:

If the request is successful, you will receive the HTTP 200 OK success status response code.

{
output: 
	{
	"uid": "<param_uid>",
	"param": 
		{
		"key": "<param_name>",
		"value": "<param_value>",
		"required": <true || false>,
		"isPassword": <true || false>            
		},
		"project_uid": "<project_uid>",
		"tenant_uid": "<tenant_uid>"
		}
}

Get a project parameter

Allows you to retrieve a project parameter.

Steps:

  1. In a REST client platform, add the authentication details of the tenant from where you want to retrieve the details of a project parameter.

    	Headers: 
    	{
    	Authorization: BasicAuth
    	}
  2. Perform a GET request at the URL of the project.

    URL Syntax: <domain>/apis/v1/rest/projects/:project/params/param_uid

    In this URL request, /:project is the name of the project associated with the parameter and the details you want to retrieve, and param_uid is the ID of the parameter and the details you want to retrieve.

    Method: GET

Output:

{
output: 
		{
		"uid": "<param_uid>",
		"param": 
		{
		"key": "<param_name>",
		"value": "<param_value>",
		"required": <true || false>,
		"isPassword": <true || false>            
		},
		"project_uid": "<project_uid>",
		"tenant_uid": "<tenant_uid>"
	}
}

List project parameters

Allows you to retrieve a list of all the project parameters created in a particular project.

Steps:

  1. In a REST client platform, add the authentication details of the tenant from where you want to list project parameters.

    Headers: 
    	{
    	Authorization: BasicAuth
    	}
  2. Perform a GET request at the URL of the project.

    URL syntax: <domain>/apis/v1/rest/projects/:project/params

    In this URL request, /:project is the name of the project from where you want to fetch the list of all the parameters.

    Method: GET

Output:

If the request is successful, you will receive the HTTP 200 OK success status response code.

{
output: 
	[{
		"uid": "<param_uid>",
		"param": 
		{
		"key": "<param_name>",
		"value": "<param_value>",
		"required": <true || false>,
		"isPassword": <true || false>            
		},
		"project_uid": "<project_uid>",
		"tenant_uid": "<tenant_uid>"
	}]
}

Delete a project parameter

Allows you to delete a project parameter.

Steps:

  1. In a REST client platform, add the authentication details of the tenant from where you want to delete a project parameter.

    Headers: 
    	{
    	Authorization: BasicAuth
    	}
  2. Perform a DELETE request at the URL of the project.

    URL syntax: <domain>/apis/v1/rest/projects/:project/params/param_uid

    In this URL request, /:project is the name of the project from where you want to delete a project parameter and param_uid is the ID of the parameter you want to delete.

    Method: DELETE

Output:

If the request is successful, you will receive the HTTP 200 OK success status response code.

Case 1: If the parameter you want to delete is not being used in any workflow in the specified project, you will get the following output:

{
output:  
	{
	"message": "Param(s) deleted successfully."
	}
}

Case 2: If the parameter you want to delete is being used in any workflow in the specified project, you will get the following output:

{
	"output": 
		{
		"message": "This param is used in the below workflow(s). Please remove it from the workflow(s) before deleting this project param.",
		"workflows": 
			[
				{
				"uid": "<workflow_uid>",
				"name": "<workflow_name>",
				"activities": 
				[
				"<workflow_activity_id>"                                             
				],
				"flow_version": 
				[
				"<workflow_version>"  
				]
				}
			]
		}
}

Role Management APIs

Create

Allows you to create a new role for a particular tenant.

Steps:

  1. In a REST client platform, add the authentication details of the tenant where you want to create a new role.

    Headers: 
    	{
    	Authorization: BasicAuth
    	}
    Body: 
    	{
    	"name": "<role_name>*^",
    	"description": "<role_description>",
    	"projects": 
    	[{
    	"<project_name>": ["r", "w", "e"]  
    	}]
    }
    
    // A field with the asterisk (*) character in the body of the request is a required field. 
    // A field with the caret (^) character in the body of the request indicates that the field  can only have unique values.
  2. Perform a POST request at the URL of the project.

    URL syntax: <domain>/apis/v1/rest/roles

    Method: POST

Output:

If the request is successful, you will receive the HTTP 201 OK success status response code.

{
output : 
{
"name": <role_name>,
"uid": <role_uid>,
"tenant_uid": <project_tenant_uid>,
"permissions": 
		[
			{
			"project_uid": "<project_uid>",
			"access_list": 
			{
			"read": true,
			"write": true,
			"execute":true                  
			}
			}
		],
"created_at": "<role_created_at>",
"updated_at": "<role_updated_at>",
}
}

Update

Allows you to update an existing role.

Steps:

  1. In a REST client platform, add the authentication details of the tenant where you want to update an existing role.

    Headers: 
    	{
    	Authorization: BasicAuth
    	}
    Body: 
    	{
    	"name": "<role_name>*^",
    	"description": "<role_description>",
    	"projects": 
    	[{
    	"<project_name>": ["r", "w", "e"]  
    	}]
    }
    
    // A field with the asterisk (*) character in the body of the request is a required field. 
    // A field with the caret (^) character in the body of the request indicates that the field can only have unique values.
  2. Perform a PUT request at the URL of the project.

    URL syntax: <domain>/apis/v1/rest/roles/:role_uid

    In this URL request, /:role_uid is the ID of the role you want to update.

    Method: PUT

Output:

If the request is successful, you will receive the HTTP 200 OK success status response code.

{
output : 
{
	"name": <role_name>,
	"uid": <role_uid>,
	"tenant_uid": <project_tenant_uid>,
	"permissions": 
		[
			{
			"project_uid": "<project_uid>",
			"access_list": 
			{
			"read": true,
			"write": true,
			"execute":true                  
			}
			}
		],
"created_at": "<role_created_at>",
"updated_at": "<role_updated_at>",
}
}

Delete

Allows you to delete a particular role.

Steps:

  1. In a REST client platform, add the authentication details of the tenant from where you want to delete a role.

    Headers: 
    	{
    	Authorization: BasicAuth
    	}
  2. Perform a DELETE request at the URL of the project.

    URL syntax: <domain>/apis/v1/rest/roles/:role_uid

    In this URL request, /:role_uid is the ID of the role you want to delete.

    Method: DELETE

Output:

If the request is successful, you will receive the HTTP 200 OK success status response code.

{
output : 
	{
	message: "Tenant role deleted."
	}
}

Get role details

Allows you to retrieve details of a particular role.

Steps:

  1. In a REST client platform, add the authentication details of the tenant from where you want to retrieve details of a specific role.

    Headers: 
    	{
    	Authorization: BasicAuth
    	}
  2. Perform a GET request at the URL of the project.

    URL syntax: <domain>/apis/v1/rest/roles/:role_uid

    In this URL request, /:role_uid is the ID of the role, the details of which you want to retrieve.

    Method: GET

Output:

If the request is successful, you will receive the HTTP 200 OK success status response code.

{
output : 
{
"name": <role_name>,
"uid": <role_uid>,
"tenant_uid": <project_tenant_uid>,
"permissions": 
	[
		{
		"project_uid": "<project_uid>",
		"access_list": 
		{
		"read": true,
		"write": true,
		"execute":true                  
		}
		}
	],
"created_at": "<role_created_at>",
"updated_at": "<role_updated_at>",
}
}

You can alternatively add the query parameter ?edit=true to the URL request <domain>/apis/v1/rest/roles/:role to retrieve brief details of a particular role. On appending the specified query parameter to the URL request, you will receive the output in the following format:

Output:

{
output :  
{
	"name": "<role_name>",
	"description": "<role_description>",
	"projects": 
	[{
	"<project_name>": ["r", "w", "e"]  
	}]
}
}

Get a list of rows

Allows you to retrieve a collection of roles associated with a particular tenant.

Steps:

  1. In a REST client platform, add the authentication details of the tenant from where you want to retrieve a list of roles.

    Headers: 
    	{
    	Authorization: BasicAuth
    	}
  2. Perform a GET request at the URL of the project.

    URL syntax: <domain>/apis/v1/rest/roles

    You can control and filter the output response by using the URL query parameters. In this URL request,

    • If you want to skip a certain number of pages at the beginning of the collection in the response, append the query parameter ?skip=n to the URL request, where n is the number of pages you want to skip. The default value for n is 0.
    • If you want to define the maximum page size starting from the n-th one, append ?limit=m to the URL request, where m is the total number of records you want to include in the response. The default value for m is 1000.

    Method: GET

Output:

If the request is successful, you will receive the HTTP 200 OK success status response code.

{
output:
{
	"count": <tenant_role_count>,
	"objects": 
	[{
	"name": <role_name>,
	"uid": <role_uid>,
	"tenant_uid": <project_tenant_uid>,
	"permissions": 
		[
			{
			"project_uid": "<project_uid>",
			"access_list":
				{
				"read": true,
				"write": true,
				"execute":true                  
				}
			}
		],
"created_at": "<role_created_at>",
"updated_at": "<role_updated_at>",
}]       
}    
}

User Management APIs

Get a list of users

Allows you (the admin) to retrieve a list of users associated with a particular tenant.

Steps:

  1. In a REST client platform, add the authentication details of the tenant to retrieve a list of tenant users.

    Headers: 
    	{
    	Authorization: BasicAuth
    	}
  2. Perform a GET request at the URL of the project.

    URL syntax: <domain>/apis/v1/rest/users

    Method: GET

Output:

If the request is successful, you will receive the HTTP 200 OK success status response code.

{
output :
{
	"count": <tenant_user_count>,
	"objects": 
		[{
		"uid": "<user_uid>",
		"email": "<user_email>",
		"first_name": "<user_first_name>",
		"last_name": "<user_last_name>",
		"roles":
			[
			<role_data>
			],
		"wmic_username": "<user_uid>",
		"is_admin": true || false,
		"is_developer": true || false,                
		"is_owner": true || false
		}]
}      
}   

Assign roles to a user

Allows you (the admin) to assign roles to a tenant user.

Steps:

  1. In a REST client platform, add the authentication details of the tenant to assign roles to a user.

    Headers:
    	{
    	Authorization: BasicAuth
    	}
    Body:
    	{
    	"username":<tenant_username>
    	"roles": ['role1','role2']
    	}
  2. Perform a PUT request at the URL of the project.

    URL syntax: <domain>/apis/v1/rest/assign-roles

    Method: PUT

Output:

If the request is successful, you will receive the HTTP 200 OK success status response code.

{
output:
{
	"uid": "<user_uid>",
	"email": "<user_email>",
	"first_name": "<user_first_name>",
	"last_name": "<user_last_name>",
	"roles":
		[
		<role_data>
		],
	"wmic_username": "<user_uid>",
	"is_admin": true || false,
	"is_developer": true || false,                
	"is_owner": true || false
}      
} 

Themes APIs

Create

Allows you to create a new theme for a particular tenant.

Steps:

  1. In a REST client platform, add the authentication details of the tenant where you want to create a new theme.

    Headers: 
    	{
    	Authorization: BasicAuth
    	}
    Body:
    	{
    	"name": "<theme_name>*^",
    	"description": "<theme_description>",
    	"theme":<theme_values_obj>#,
    	"footerContent":"<theme_footerContent>",
    	"aboutPageContent":"<theme_aboutPageContent>" 
    	}
    	
    // A field with the asterisk (*) character in the body of the request is a required field. 
    // A field with the caret (^) character in the body of the request indicates that the field can only have unique values. 
    // The hash (#) character in the body of the request indicates that the field contains the object of the applied theme in the specified tenant.
    // You could get the theme object by performing a GET method request at the URL "<domain>/apis/v1/rest/themes/defaultvalues".
  2. Perform a POST request at the URL of the project.

    URL syntax: <domain>/apis/v1/rest/themes

    Method: POST

Output:

If the request is successful, you will receive the HTTP 201 OK success status response code.

{
output: 
	{
	"name": "<theme_name>",
	"uid": "<theme_uid>",
	"settings": 
		{
		"description": "<theme_name>",
		"theme":<theme_values_obj>,
		"footerContent": "<theme_footerContent>",
		"aboutPageContent": "<theme_aboutPageContent>"
		},
	"active": <true || false>,
}
}

Update

Allows you to update an existing theme in a particular tenant.

Steps:

  1. In a REST client platform, add the authentication details of the tenant where you want to update an existing theme.

    Headers: 
    	{
    	Authorization: BasicAuth
    	}
    Body: 
    	{
    	"name": "<theme_name>*^",
    	"description": "<theme_description>",
    	"footerContent":"<theme_footerContent>",
    	"aboutPageContent":"<theme_aboutPageContent>" 
    	}
    	
    // A field with the asterisk (*) character in the body of the request is a required field. 
    // A field with the caret (^) character in the body of the request indicates that the field can only have unique values. 	
  2. Perform a PUT request at the URL of the project.

    URL syntax: <domain>/apis/v1/rest/themes/:theme_uid

    In this URL request, /:theme_uid is the ID of the theme you want to update.

    Method: PUT

Output:

If the request is successful, you will receive the HTTP 200 OK success status response code.

{
output: 
	{
	"name": "<theme_name>",
	"uid": "<theme_uid>",
	"settings": 
		{
		"description": "<theme_name>",
		"theme":<theme_values_obj>,
		"footerContent": "<theme_footerContent>",
		"aboutPageContent": "<theme_aboutPageContent>"
		},
	active": <true || false>,
	}
}

Delete

Allows you to delete a theme for a particular tenant.

Steps:

  1. In a REST client platform, add the authentication details of the tenant from where you want to delete a theme.

    Headers: 
    	{
    	Authorization: BasicAuth
    	}
  2. Perform a DELETE request at the URL of the project.

    URL syntax: <domain>/apis/v1/rest/themes/:theme_uid

    In this URL request, /:theme_uid is the ID of the theme you want to delete.

    Method: DELETE

Output:

If the request is successful, you will receive the HTTP 200 OK success status response code.

{
output: 
	{
	"message": "Object deleted successfully."
	}
}

List themes

Allows you to retrieve details of all themes for a particular tenant.

Steps:

  1. In a REST client platform, add the authentication details of the tenant from where you want to retrieve details of all themes.

    Headers: 
    	{
    	Authorization: BasicAuth
    	}
  2. Perform a GET request at the URL of the project.

    URL syntax: <domain>/apis/v1/rest/themes

    Method: GET

Output:

If the request is successful, you will receive the HTTP 200 OK success status response code.

{
output: 
	[{
	"name": "<theme_name>",
	"uid": "<theme_uid>",
	"settings": 
			{
			"description": "<theme_name>",
			"theme":<theme_values_obj>,
			"footerContent": "<theme_footerContent>",
			"aboutPageContent": "<theme_aboutPageContent>"
			},
	"active": <true || false>,
	}]
}

Activate a theme

Allows you to activate a theme for a particular tenant.

Steps:

  1. In a REST client platform, add the authentication details of the tenant where you want to activate a theme.

    Headers: 
    	{
    	Authorization: BasicAuth
    	}
  2. Perform a PUT request at the URL of the project.

    URL syntax: <domain>/apis/v1/rest/themes/:theme_uid/activate

    In this URL request, /:theme_uid is the ID of the theme you want to activate.

    Method: PUT

Output:

If the request is successful, you will receive the HTTP 200 OK success status response code.

{
output: 
	{
	"name": "<theme_name>",
	"uid": "<theme_uid>",
	"settings": 
		{
		"description": "<theme_name>",
		"theme":<theme_values_obj>,
		"footerContent": "<theme_footerContent>",
		"aboutPageContent": "<theme_aboutPageContent>"
		},
	"active": true,
	}	
}

Deactivate a theme

Allows you to deactivate the specified theme from a particular tenant.

Steps:

  1. In a REST client platform, add the authentication details of the tenant to deactivate the applied theme.

    Headers: 
    	{
    	Authorization: BasicAuth
    	}
  2. Perform a PUT request at the URL of the project.

    URL syntax: <domain>/apis/v1/rest/themes/:theme_uid/deactivate

    In this URL request, /:theme_uid is the ID of the theme you want to deactivate.

    Method: PUT

Output:

If the request is successful, you will receive the HTTP 200 OK success status response code.

{
output: 
	{
	"name": "<theme_name>",
	"uid": "<theme_uid>",
	"active": false,
	}
}

Retrieve a theme

Allows you to retrieve details of a specific theme from a particular tenant.

Steps:

  1. In a REST client platform, add the authentication details of the tenant from where you want to retrieve a specific theme.

    Headers: 
    	{
    	Authorization: BasicAuth
    	}
  2. Perform a GET request at the URL of the project.

    URL syntax: <domain>/apis/v1/rest/themes/:theme_uid

    In this URL request, /:theme_uid is the ID of the theme, the details you want to retrieve.

    Method: GET

Output:

If the request is successful, you will receive the HTTP 200 OK success status response code.

{
output: 
	{
	"name": "<theme_name>",
	"uid": "<theme_uid>",
	"active": <true || false>,
	}
}

Retrieve default theme values

Allows you to retrieve default values for the current theme.

Steps:

  1. In a REST client platform, add the authentication details of the tenant to retrieve default values of the current theme.

    Headers: 
    	{
    	Authorization: BasicAuth
    	}
  2. Perform a GET request at the URL of the project.

    URL syntax: <domain>/apis/v1/rest/themes/defaultvalues

    Method: GET

Output:

If the request is successful, you will receive the HTTP 200 OK success status response code.

{
output: 
	{
	"primaryColor": "<primaryColor>",
	"primaryHeaderTextColor": "<primaryHeaderTextColor>",
	"primaryTextColor": "<primaryTextColor>",
	"linkColor": "<linkColor>",
	"primaryHoverColor": "<primaryHoverColor>",
	"backgroundImage": "<backgroundImage>",
	"logoFileName": "<logoFileName>",
	"primaryBtnBgColor": "<primaryBtnBgColor>",
	"primaryBtnColor": "<primaryBtnColor>",
	"primaryBtnBrbColor": "<primaryBtnBrbColor>",
	"secondaryBtnBgColor": "<secondaryBtnBgColor>",
	"secondaryBtnColor": "<secondaryBtnColor>",
	"secondaryBtnBrbColor": "<secondaryBtnBrbColor>",
	"favIconImage": "<favIconImage>",
	"favIconFileName": "<favIconFileName>",
	"footerContent": "",
	"aboutPageContent": ""
    }
}

Webhook APIs

Get webhook-enabled workflows

Allows you to retrieve details of workflows that are webhook-enabled.

Steps:

  1. In a REST client platform, add the authentication details of the tenant from where you want to retrieve details of webhook-enabled workflows.

    Headers: 
    	{
    	Authorization: BasicAuth
    	}
  2. Perform a GET request at the URL of the project.

    URL syntax: <domain>/apis/v1/rest/projects/:project/webhook-flows

    In this URL request, /:project is the name of the project from where you want to retrieve details of webhook-enabled workflows.

    You can control and filter the output response by using the URL query parameters. In this URL request:

    • If you want to skip a certain number of pages at the beginning of the collection in the response, append the query parameter ?skip=n to the URL request, where n is the number of pages you want to skip. The default value for n is 0.
    • If you want to define the maximum page size starting from the n-th one, append ?limit=m to the URL request, where m is the total number of records you want to include in the response. The default value for m is 1000.

    Method: GET

Output:

If the request is successful, you will receive the HTTP 200 OK success status response code.

{
output: 
	{
	"objects": 
		[
		{
		"uid": "<workflow_uid>",
		"sid": <workflow_sid>
		"name": "<workflow_name>",
		"tenant_uid": "<tenant_uid>",
		"project_uid": "<project_uid>",
		"webhook_settings": <workflow_webhook_settings>               
		}        
        ],
	"count": <webhook_workflow_count>
	}
}

Regenerate webhook URL

Allows you to regenerate webhook URL for an existing workflow in a particular tenant.

Steps:

  1. In a REST client platform, add the authentication details of the tenant to regenerate webhook URL.

    Headers: 
    	{
    	Authorization: BasicAuth
    	}	
  2. Perform a PUT request at the URL of the project.

    URL syntax: <domain>/apis/v1/rest/projects/:project/webhook-flows/:workflow_uid/reset

    In this URL request, /:project is the name of the project associated with the workflow, the webhook URL you want to reset, and /:workflow_uid is the ID of the workflow, the webhook URL you want to reset.

    Method: PUT

Output:

If the request is successful, you will receive the HTTP 200 OK success status response code.

{
output: 
	{               
	"uid": "<workflow_uid>",
	"name": "<workflow_name>",
	"tenant_uid": "<tenant_uid>",
	"project_uid": "<project_uid>",
	"sid": <workflow_sid>,
	"webhook_url": <webhook_url>            
	}        
}

Set webhook authentication

Allows you to add an authentication mechanism to a webhook in a particular tenant.

Steps:

  1. In a REST client platform, add the authentication details of the tenant to apply an authentication to a webhook.

    Headers: 
    	{
    	Authorization: BasicAuth
    	}
    Body:
    	{
    	"auth*":"none" OR "login" OR "token"
    	}
    
    // The default value for the auth field is "login".
  2. Perform a POST request at the URL of the project.

    URL syntax: <domain>/apis/v1/rest/projects/:project/webhook-flows/:workflow_uid/auth

    In this URL request, /:project is the name of the project associated with the workflow where you want to apply an authentication to a webhook and /:workflow_uid is the ID of the workflow where you want to apply an authentication to a webhook.

    Method: POST

Output:

If the request is successful, you will receive the HTTP 200 OK success status response code.

{
output: 
		{               
		"uid": "<workflow_uid>",
		"name": "<workflow_name>",
		"tenant_uid": "<tenant_uid>",
		"project_uid": "<project_uid>",
		"sid": <workflow_sid>,
		"webhook_settings": <webhook_settings>            
		}        
}

Recipes APIs

Create

Allows you to create a new recipe in a particular tenant.

Steps:

  1. In a REST client platform, add the authentication details of the tenant where you want to create a recipe.

    Headers: 
    	{
    	Authorization: BasicAuth
    	}
    Body:
    {
    recipe: <zip_file_binary>
    }
  2. Perform a POST request at the URL of the project.

    URL syntax: <domain>/apis/v1/rest/recipes

    Method: POST

Output:

If the request is successful, you will receive the HTTP 201 OK success status response code.

{
output: 
	{        
	"uid": <recipe_uid>
	"name": "<recipe_name>",
	"description": "<description>"              	           
	}     
}

Get a recipe

Allows you to retrieve details of a particular recipe.

Steps:

  1. In a REST client platform, add the authentication details of the tenant associated with the recipe, the details you want to retrieve.

    Headers: 
    	{
    	Authorization: BasicAuth
    	}
  2. Perform a GET request at the URL of the project.

    URL syntax: <domain>/apis/v1/rest/recipes/:uid

    In this URL request, :uid is the ID of the recipe you want to retrieve.

    Method: GET

Output:

If the request is successful, you will receive the HTTP 200 OK success status response code.

{
output: 
	{      	         
	"uid": <recipe_uid>
	"name": "<recipe_name>",
	"description": "<description>",
	"download": "<recipe_download_count>"                             
	}  
}

Get all recipes

Allows you to retrieve all recipes for a particular tenant.

Steps:

  1. In a REST client platform, add the authentication details of the tenant from where you want to retrieve recipes.

    Headers: 
    	{
    	Authorization: BasicAuth
    	}
  2. Perform a GET request at the URL of the project.

    URL syntax: <domain>/apis/v1/rest/recipes

    You can control and filter the output response by using the URL query parameters. In this URL request:

    • If you want to skip a certain number of pages at the beginning of the collection in the response, append the query parameter ?skip=n to the URL request, where n is the number of pages you want to skip. The default value for n is 0.
    • If you want to define the maximum page size starting from the n-th one, append ?limit=m to the URL request, where m is the total number of records you want to include in the response. The default value for m is 1000.
    • If you want to retrieve details of all unpublished recipes from a particular tenant, append ?my_recipe=true to the URL request.

    Method: GET

Output:

If the request is successful, you will receive the HTTP 200 OK success status response code.

{
output: 
	{
	"count":<total_recipe_count>,
	"objects":
		[
		{               
		"uid": <recipe_uid>
		"name": "<recipe_name>",
		"description": "<description>",
		"download": "<recipe_download_count>"                             
		}        
        ]
	}
}

Delete

Allows you to delete a recipe from your tenant.

Steps:

  1. In a REST client platform, add the authentication details of the tenant from where you want to delete a recipe.

    Headers: 
    	{
    	Authorization: BasicAuth
    	}
  2. Perform a DELETE request at the URL of the project.

    URL syntax: <domain>/apis/v1/rest/recipes/:uid

    In this URL request, /:uid is the ID of the recipe you want to delete.

    Method: DELETE

Output:

If the request is successful, you will receive the HTTP 200 OK success status response code.

{
output: 
	{
	"message": "Object deleted successfully."
	}
}

Example - Using a webMethods.io Integration API to execute a workflow

Note: To execute a workflow by using a webMethods.io Integration API, you will have to use an external service that is capable of sending HTTP requests. In our example, we will use Postman.

Let’s now understand how to use a webMethods.io Integration API to execute a particular workflow.

Before you begin

  1. Log in to your webMethods.io Integration tenant.
  2. Create a workflow and save it.
  3. Download the Postman app (Windows 64-bit), install the app, and then sign-in to Postman.

Let’s say, you have a workflow named Sample Workflow that creates a board named Dev Team Status Board in your Trello account.

To execute this workflow using a webMethods.io Integration API, follow the procedure given below:

Basic Flow

  1. Open the Postman app and click Create New.
  2. On the Postman app Request page, click the Authorization tab, and select Basic Auth from the Type dropdown list. Add the authentication details of the tenant associated with the workflow you want to execute.

    In our example, we will add the authentication details of the tenant associated with the Sample Workflow workflow.

  3. To execute a workflow by using a webMethods.io Integration API, we would be referring to the Workflow APIs - Execute section.

    Perform a POST request at the URL of the workflow you want to execute. Use the URL Syntax: <domain>/apis/v1/rest/projects/:project/workflows/:workflow/run

    In this URL syntax,

    • domain is the tenant URL provided by webMethods.io Integration, for example, https://sample-tenant.int-aw-us1.webmethods-int.io.
    • /:project is the name of the project associated with the workflow you want to execute, for example, Sample_Project.
    • /:workflow is the UID of the workflow you want to execute, for example, fla95fc030gfb181194bb363.

  4. Note: To retrieve the UID of the workflow, in webMethods.io Integration, navigate to the workflow you want to execute. At this point, your tenant URL will look like this: https://sample-tenant.int-aw-us1.webmethods-int.io/#/projects/fl102d2ad2e4r7d78b1811ea/workflows/fla95fc030gfb181194bb363/edit. The UID of the workflow is the alphanumeric characters that appear after /workflows in the URL. Here, the UID of the workflow is fla95fc030gfb181194bb363.

  5. Click Send to execute the workflow.

    On successful execution, you will see the output in the Postman interface.

    Check the execution logs in the Workflow Execution screen on the Monitor page. You will see that the workflow is executed. You can click on the name of the workflow to get the complete information on the performance of the workflow.

    If you check the Workspace in your Trello account, you will see a new board named Dev Team Status Board added to the list of existing boards.

  6. Note: You can save the API requests in Postman Collections for future use.