Update an existing flow template

PATCH

https://api.platform.openintegrationhub.com/templates/{id}

templates

The id is used to match the existing Flow Template that will be updated. Requires the 'flowTemplates.write' permission.

Request

Path Params

string <string>

required

ID of flow template to update

Body Params application/json

name

string

required

Example:

SnazzyToCodeComponent

description

string

optional

Example:

This flow polls for persons and posts them on webhoo.site.

graph

object (FlowGraph)

required

nodes

array [object {7}]

optional

An array of all components involved in this flow

edges

array [object {4}]

optional

An array of edges linking nodes together, determining the order in which nodes are activated

type

enum<string>

required

Flow type

Allowed values:

ordinaryrealtime

Example:

ordinary

cron

string

optional

A cron string describing the interval at which this flow is run. If unset, the flow uses webhooks instead

Example:

* /2 * * * *

owners

array[object (Owner) {2}]

optional

string

required

External id of the owner

type

string

required

Type to discriminate between user or tenant

Example

{
    "name": "SnazzyToCodeComponent",
    "description": "This flow polls for persons and posts them on webhoo.site.",
    "graph": {
        "nodes": [
            [
                {
                    "id": "step_1",
                    "componentId": "string",
                    "name": "snazzy adapter for oih",
                    "function": "getPersonsPolling",
                    "description": "New description in progress"
                },
                {
                    "id": "step_2",
                    "componentId": "string",
                    "name": "code_component",
                    "function": "execute",
                    "description": "",
                    "fields": {
                        "code": "function* run() {console.log('Calling external URL');yield request.post({uri: 'http://webhook.site/debc8244-3ca0-4449-af2b-e346c4f57b85', body: msg.body, json: true});}"
                    }
                }
            ]
        ],
        "edges": [
            {
                "id": "string",
                "config": {
                    "condition": "string",
                    "mapper": {}
                },
                "source": "step_1",
                "target": "step_2"
            }
        ]
    },
    "type": "ordinary",
    "cron": "* /2 * * * *",
    "owners": [
        {
            "id": "string",
            "type": "string"
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://api.platform.openintegrationhub.com/templates/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "SnazzyToCodeComponent",
    "description": "This flow polls for persons and posts them on webhoo.site.",
    "graph": {
        "nodes": [
            [
                {
                    "id": "step_1",
                    "componentId": "string",
                    "name": "snazzy adapter for oih",
                    "function": "getPersonsPolling",
                    "description": "New description in progress"
                },
                {
                    "id": "step_2",
                    "componentId": "string",
                    "name": "code_component",
                    "function": "execute",
                    "description": "",
                    "fields": {
                        "code": "function* run() {console.log('\''Calling external URL'\'');yield request.post({uri: '\''http://webhook.site/debc8244-3ca0-4449-af2b-e346c4f57b85'\'', body: msg.body, json: true});}"
                    }
                }
            ]
        ],
        "edges": [
            {
                "id": "string",
                "config": {
                    "condition": "string",
                    "mapper": {}
                },
                "source": "step_1",
                "target": "step_2"
            }
        ]
    },
    "type": "ordinary",
    "cron": "* /2 * * * *",
    "owners": [
        {
            "id": "string",
            "type": "string"
        }
    ]
}'

Responses

🟢200OK

application/json

The updated Flow Template.

Body

data

object (FlowTemplate)

optional

name

string

required

Example:

SnazzyToCodeComponent

description

string

optional

Example:

This flow polls for persons and posts them on webhoo.site.

graph

object

FlowGraph

required

type

enum<string>

required

Flow type

Allowed values:

ordinaryrealtime

Example:

ordinary

cron

string

optional

A cron string describing the interval at which this flow is run. If unset, the flow uses webhooks instead

Example:

* /2 * * * *

owners

array[object (Owner) {2}]

optional

string

required

status

enum<string>

optional

Flow status, set automatically in response to start/stop commands

Allowed values:

publisheddraft

Example:

draft

meta

object

optional

Example

{
    "data": {
        "name": "SnazzyToCodeComponent",
        "description": "This flow polls for persons and posts them on webhoo.site.",
        "graph": {
            "nodes": [
                [
                    {
                        "id": "step_1",
                        "componentId": "string",
                        "name": "snazzy adapter for oih",
                        "function": "getPersonsPolling",
                        "description": "New description in progress"
                    },
                    {
                        "id": "step_2",
                        "componentId": "string",
                        "name": "code_component",
                        "function": "execute",
                        "description": "",
                        "fields": {
                            "code": "function* run() {console.log('Calling external URL');yield request.post({uri: 'http://webhook.site/debc8244-3ca0-4449-af2b-e346c4f57b85', body: msg.body, json: true});}"
                        }
                    }
                ]
            ],
            "edges": [
                {
                    "id": "string",
                    "config": {
                        "condition": "string",
                        "mapper": {}
                    },
                    "source": "step_1",
                    "target": "step_2"
                }
            ]
        },
        "type": "ordinary",
        "cron": "* /2 * * * *",
        "owners": [
            {
                "id": "string",
                "type": "string"
            }
        ],
        "id": "string",
        "status": "published",
        "tags": [
            "advanced",
            "premium"
        ],
        "createdAt": "2019-07-30T12:52:45.957Z",
        "updatedAt": "2019-07-30T12:52:45.957Z"
    },
    "meta": {}
}

🟠404Record Not Found

🟠409409

Modified at 2025-01-16 10:20:46

Deletes a flow template

Generate a flow from the flow template