Workflow APIs

Workflow APIs provide comprehensive workflow management capabilities including creating, updating, and managing automated workflows within your organization. These APIs enable you to build, deploy, and manage complex business processes and automation workflows.

Workflow APIs

Overview

Workflow APIs allow you to manage automated workflows, business processes, and workflow templates within your iMBRACE workspace. These APIs provide the foundation for building sophisticated automation systems, managing workflow execution, and controlling business process flows.

1. Get workflow

Retrieve all workflows available in the system.

  • Endpoint for Product: GET https://app-gateway.imbrace.co/v1/backend/n8n/workflows

  • Endpoint for Demo: GET https://app-gateway.demo.imbrace.co/v1/backend/n8n/workflows

  • Endpoint for Dev: GET https://app-gateway.dev.imbrace.co/v1/backend/n8n/workflows

  • Headers:

    • Content-Type: application/json

    • x-access-token: Your Access TokenYour Access Token

  • Body:

  • Result:

    • Status code: 200 OK

        {
        "data": [
            {
                "id": "12845",
                "name": "kong1",
                "active": false,
                "nodes": [
                    {
                        "parameters": {
                            "icsTitle": "Start"
                        },
                        "name": "Start",
                        "type": "n8n-nodes-base.start",
                        "typeVersion": 1,
                        "position": [
                            62,
                            334.5
                        ],
                        "nodeStyleVersion": 2
                    },
                    {
                        "parameters": {
                            "path": "05e73bb7-3c95-46fc-aa5a-94b2f34a1beb",
                            "options": {},
                            "icsTitle": "Webhook",
                            "displayWebhookUrls": true,
                            "retrigger": false,
                            "authentication": "none",
                            "httpMethod": "POST",
                            "responseMode": "onReceived",
                            "responseCode": 200
                        },
                        "name": "Webhook",
                        "type": "n8n-nodes-base.webhook",
                        "typeVersion": 1,
                        "position": [
                            140,
                            400
                        ],
                        "webhookId": "05e73bb7-3c95-46fc-aa5a-94b2f34a1beb",
                        "nodeStyleVersion": 2
                    }
                ],
                "connections": {},
                "createdAt": "2025-09-03T02:12:28.912Z",
                "updatedAt": "2025-09-03T02:12:28.912Z",
                "settings": {},
                "staticData": null,
                "description": null,
                "tags": [
                    {
                        "id": "61",
                        "name": "automation",
                        "createdAt": "2022-12-09T09:46:44.442Z",
                        "updatedAt": "2022-12-09T09:46:44.442Z"
                    },
                    {
                        "id": "62",
                        "name": "web",
                        "createdAt": "2022-12-09T09:52:36.513Z",
                        "updatedAt": "2022-12-09T09:52:36.513Z"
                    }
                ]
            }
        ]
    }

  • Status code: 404 Not Found

        {
        "message": "Not Found"
    }

  • Example:

    curl --location 'https://app-gateway.imbrace.co/v1/backend/n8n/workflows' \
--header 'X-Access-Token: acc_3064efc7-4ccc-4b48-8ffa-50313e5b19df' \
--data ''

2. Get workflow by Id

Retrieve details of a workflow by its ID.

  • Endpoint for Product: GET https://app-gateway.imbrace.co/v1/backend/n8n/workflows/{id}

  • Endpoint for Demo: GET https://app-gateway.demo.imbrace.co/v1/backend/n8n/workflows/{id}

  • Endpoint for Dev: GET https://app-gateway.dev.imbrace.co/v1/backend/n8n/workflows/{id}

  • Headers:

    • Content-Type: application/json

    • x-access-token: Your Access TokenYour Access Token

  • Body:

  • Result:

    • Status code: 200 OK

  • Status code: 404 Not Found

  • Example:

3. Get Workflows by Tag

Retrieve workflows filtered by specific tags.

This API allows you to fetch workflows that are associated with specific tags. It's useful for organizing and filtering workflows by categories, channels, or other classification systems.

  • Endpoint for Product: GET https://app-gateway.imbrace.co/v1/backend/workflows?tag=automation

  • Endpoint for Demo: GET https://app-gateway.demo.imbrace.co/v1/backend/workflows?tag=automation

  • Endpoint for Dev: GET https://app-gateway.dev.imbrace.co/v1/backend/workflows?tag=automation

  • Headers:

    • X-Access-Token: Your Access TokenYour Access Token

    • Cookie: n8n-auth=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9... (optional, for n8n authentication)

  • Query Parameters:

    • tag (string, required): Tag name to filter workflows by

  • Result:

    • Status code: 200 OK

  • Response Fields:

    • data (array): Array of workflow objects matching the tag filter

  • Workflow Object Fields:

    • id (string): Workflow identifier

    • name (string): Workflow name

    • active (boolean): Whether the workflow is currently active

    • createdAt (string): Workflow creation timestamp

    • updatedAt (string): Last update timestamp

    • tags (array): Array of tag objects associated with the workflow

    • channel (object, optional): Channel information if workflow is associated with a channel

      • id (string): Channel identifier

      • is_init (boolean): Whether this is an initialization channel

      • type (string): Channel type (web, whatsapp, facebook, etc.)

      • name (string): Channel name

  • Tag Object Fields:

    • id (string): Tag identifier

    • name (string): Tag name

    • createdAt (string): Tag creation timestamp

    • updatedAt (string): Last update timestamp

  • Common Tag Types:

    • automation - Automated workflows

    • web - Web widget workflows

    • whatsapp - WhatsApp channel workflows

    • facebook - Facebook channel workflows

    • wechat - WeChat channel workflows

    • line - LINE channel workflows

    • email - Email channel workflows

    • preset - Preset workflow templates

  • Error Responses:

    • Status code: 401 Unauthorized

    • Status code: 403 Forbidden

  • Example:

4. Get workflow by Channel Type

Retrieve details of a workflow by its ID.

  • Endpoint for Product: GET https://app-gateway.imbrace.co/v1/backend/workflows/channel_automation?channelType=web

  • Endpoint for Demo: GET https://app-gateway.demo.imbrace.co/v1/backend/workflows/channel_automation?channelType=web

  • Endpoint for Dev: GET https://app-gateway.dev.imbrace.co/v1/backend/workflows/channel_automation?channelType=web

  • Headers:

    • Content-Type: application/json

    • x-access-token: Your Access TokenYour Access Token

  • Body:

  • Result:

    • Status code: 200 OK

  • Status code: 404 Not Found

  • Example:

5. Get Credentials

Retrieve all credentials available in the system.

This API allows you to fetch all credentials that are stored in the system. Credentials are used for authentication with external services and APIs within workflows.

  • Endpoint for Product: GET https://app-gateway.imbrace.co/v1/backend/n8n/credentials

  • Endpoint for Demo: GET https://app-gateway.demo.imbrace.co/v1/backend/n8n/credentials

  • Endpoint for Dev: GET https://app-gateway.dev.imbrace.co/v1/backend/n8n/credentials

  • Headers:

    • Content-Type: application/json

    • x-access-token: Your Access TokenYour Access Token

  • Body:

    • No request body required

  • Result:

    • Status code: 200 OK

  • Error Responses:

    • Status code: 401 Unauthorized

    • Status code: 403 Forbidden

  • Example:

6. Get workflow by Channel Type

Retrieve details of a workflow by its ID.

  • Endpoint for Product: GET https://app-gateway.imbrace.co/v1/backend/users/:user_id/workflows

  • Endpoint for Demo: GET https://app-gateway.demo.imbrace.co/v1/backend/users/:user_id/workflows

  • Endpoint for Dev: GET https://app-gateway.dev.imbrace.co/v1/backend/users/:user_id/workflows

  • Headers:

    • Content-Type: application/json

    • x-access-token: Your Access TokenYour Access Token

  • Body:

  • Result:

    • Status code: 200 OK

  • Status code: 404 Not Found

  • Example:

7. Get workflow by Credential id

Retrieve details of a workflow by its ID.

  • Endpoint for Product: GET https://app-gateway.imbrace.co/v1/backend/workflow/credentials/:credential_id

  • Endpoint for Demo: GET https://app-gateway.demo.imbrace.co/v1/backend/workflow/credentials/:credential_id

  • Endpoint for Dev: GET https://app-gateway.dev.imbrace.co/v1/backend/workflow/credentials/:credential_id

  • Headers:

    • Content-Type: application/json

    • x-access-token: Your Access TokenYour Access Token

  • Body:

  • Result:

    • Status code: 200 OK

  • Status code: 404 Not Found

  • Example:

8. Update Workflow

Update an existing workflow with new configuration and settings.

This API allows you to modify an existing workflow by updating its name, active status, nodes, connections, and other properties. This is useful for making changes to workflow logic, adding new nodes, or updating workflow settings.

  • Endpoint for Product: PATCH https://app-gateway.imbrace.co/v1/backend/workflow/{workflow_id}

  • Endpoint for Demo: PATCH https://app-gateway.demo.imbrace.co/v1/backend/workflow/{workflow_id}

  • Endpoint for Dev: PATCH https://app-gateway.dev.imbrace.co/v1/backend/workflow/{workflow_id}

  • Headers:

    • Content-Type: application/json

    • X-Access-Token: Your Access TokenYour Access Token

  • Path Parameters:

    • workflow_id (string, required): The unique identifier of the workflow to update

  • Request Body (JSON):

  • Result:

    • Status code: 200 OK

  • Error Responses:

    • Status code: 400 Bad Request

    • Status code: 404 Not Found

  • Example:

9. Update Credential

Update an existing credential with new configuration and data.

This API allows you to modify an existing credential by updating its name, type, data, and node access permissions. This is useful for updating authentication details, changing credential names, or modifying access permissions for external service integrations.

  • Endpoint for Product: PATCH https://app-gateway.imbrace.co/v1/backend/workflow/credentials/{credential_id}

  • Endpoint for Demo: PATCH https://app-gateway.demo.imbrace.co/v1/backend/workflow/credentials/{credential_id}

  • Endpoint for Dev: PATCH https://app-gateway.dev.imbrace.co/v1/backend/workflow/credentials/{credential_id}

  • Headers:

    • X-Access-Token: Your Access TokenYour Access Token

  • Path Parameters:

    • credential_id (string, required): The unique identifier of the credential to update

  • Request Body (JSON):

  • Request Parameters:

    • id (string, required): Credential identifier

    • name (string, required): Updated credential name

    • type (string, required): Credential type (e.g., odooApi, httpBasicAuth, etc.)

    • data (object, required): Credential-specific data containing authentication details

      • url (string): Service URL

      • username (string): Username for authentication

      • password (string): Password for authentication

      • db (string): Database name (for Odoo API)

    • nodesAccess (array, required): Array of nodes that can access this credential

  • Result:

    • Status code: 200 OK

  • Error Responses:

    • Status code: 400 Bad Request

    • Status code: 401 Unauthorized

    • Status code: 404 Not Found

  • Example:

10. Create Workflow

Create a new workflow with specified nodes, connections, and settings.

This API allows you to create a new workflow by defining its name, nodes, connections between nodes, and other configuration settings. This is useful for building new automation workflows from scratch or creating workflow templates.

  • Endpoint for Product: POST https://app-gateway.imbrace.co/v1/backend/workflow

  • Endpoint for Demo: POST https://app-gateway.demo.imbrace.co/v1/backend/workflow

  • Endpoint for Dev: POST https://app-gateway.dev.imbrace.co/v1/backend/workflow

  • Headers:

    • Content-Type: application/json

    • X-Access-Token: Your Access TokenYour Access Token

  • Request Body (JSON):

  • Result:

    • Status code: 201 Created

  • Error Responses:

    • Status code: 400 Bad Request

    • Status code: 401 Unauthorized

    • Status code: 409 Conflict

  • Example:

11. Save Workflow

Save a new workflow with specified nodes, connections, and credentials.

This API allows you to save a new workflow by defining its name, nodes, connections, credentials, and other configuration settings. This is useful for creating workflows with specific credentials and trigger configurations.

  • Endpoint for Product: POST https://app-gateway.imbrace.co/v1/backend/n8n/workflows

  • Endpoint for Demo: POST https://app-gateway.demo.imbrace.co/v1/backend/n8n/workflows

  • Endpoint for Dev: POST https://app-gateway.dev.imbrace.co/v1/backend/n8n/workflows

  • Headers:

    • X-Access-Token: Your Access TokenYour Access Token

  • Request Body (JSON):

  • Result:

    • Status code: 200 OK

  • Response Fields:

    • data (object): Saved workflow object

      • id (string): Generated workflow identifier

      • name (string): Workflow name

      • nodes (array): Array of workflow nodes with credentials

      • connections (object): Workflow node connections

      • active (boolean): Workflow active status

      • settings (object): Workflow settings

      • tags (array): Array of workflow tags

      • staticData (object|null): Static data for the workflow

      • createdAt (string): Workflow creation timestamp

      • updatedAt (string): Last update timestamp

  • Common Trigger Node Types:

    • n8n-nodes-base.WebWidgetTrigger - Web widget trigger

    • n8n-nodes-base.webhook - Webhook trigger

    • n8n-nodes-base.scheduleTrigger - Schedule trigger

    • n8n-nodes-base.emailTrigger - Email trigger

    • n8n-nodes-base.manualTrigger - Manual trigger

  • Error Responses:

    • Status code: 400 Bad Request

    • Status code: 401 Unauthorized

    • Status code: 404 Not Found

  • Example:

12. Create Credential

Create a new credential with specified configuration and data.

This API allows you to create a new credential by defining its name, type, data, and node access permissions. This is useful for setting up authentication details for external service integrations within workflows.

  • Endpoint for Product: POST https://app-gateway.imbrace.co/v1/backend/workflow/credentials

  • Endpoint for Demo: POST https://app-gateway.demo.imbrace.co/v1/backend/workflow/credentials

  • Endpoint for Dev: POST https://app-gateway.dev.imbrace.co/v1/backend/workflow/credentials

  • Headers:

    • X-Access-Token: Your Access TokenYour Access Token

  • Request Body (JSON):

  • Request Parameters:

    • id (string, optional): Credential identifier (empty string for new credentials)

    • name (string, required): Name of the credential

    • type (string, required): Credential type (e.g., odooApi, httpBasicAuth, etc.)

    • data (object, required): Credential-specific data containing authentication details

      • url (string): Service URL

      • username (string): Username for authentication

      • password (string): Password for authentication

      • db (string): Database name (for Odoo API)

    • nodesAccess (array, required): Array of nodes that can access this credential

  • Result:

    • Status code: 201 Created

  • Error Responses:

    • Status code: 400 Bad Request

    • Status code: 401 Unauthorized

    • Status code: 409 Conflict

  • Example:

PreviousTeam APIsNextJourney API

Last updated