Add a new template to the repository

POST

https://api.platform.openintegrationhub.com/templates

This requires the 'flowTemplates.write' permissions. The new Flow Template will automatically be associated with the current user in the owners array, allowing editing and viewing by this user irrespective of tenancies.

Request

Body Params application/json

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 Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '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

🟢201Created

application/json

The created Flow Template.

Body

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": {}
}

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

Retrieve all flow templates

Find Flow Template by ID