Creating a New Template
Adding a completely new node type requires work across four layers: the database record, the Atlas Form, the frontend renderer, and the backend executor. This guide covers the step-by-step process for the template layer (database + form).
Step-by-Step: Template Creation
Choose a typeCode
Pick a unique, kebab-case identifier: e.g., "my-company-sap-push". This string cannot be changed after creation. Verify it doesn't conflict with existing types via GET /api/v1/flow-studio/node-types.
Create the Atlas Form
Design the configuration form in Atlas Forms. Note the FormId after saving. The form defines what the user can configure when the node is selected on canvas.
POST the NodeType to the API
Call POST /api/v1/flow-studio/node-types with the full NodeType JSON, including the formId from step 2 and the port definitions. The node immediately appears in the palette.
{
"typeCode": "my-company-sap-push",
"displayName": "SAP Push",
"category": "integration",
"icon": "fa-solid fa-building",
"color": "#0f7abf",
"shape": "rectangle",
"formId": 9001,
"tags": ["SAP", "ERP", "BAPI"],
"ports": [
{ "portKey": "main", "portType": "target", "isMainPort": true, "isErrorPort": false, "isRequired": true, "isMultiple": false },
{ "portKey": "main", "portType": "source", "isMainPort": true, "isErrorPort": false, "isRequired": false, "isMultiple": false },
{ "portKey": "error", "portType": "source", "isMainPort": false, "isErrorPort": true, "isRequired": false, "isMultiple": false }
]
}