FlowMate API Documentation
  1. Schemas
FlowMate API Documentation
  • Authentication
    • Login
  • Flows
    • Retrieve all flows
    • Find Flow by ID
    • Deletes a flow
    • Update an existing flow
    • Bulk update a number of existing flows
    • Start a flow
    • Stop a flow
    • Start multiple flows
    • Stop multiple flows
  • User
    • get all users
    • Create user
    • get a user by id
    • get current user
  • Templates
    • Retrieve all flow templates
    • Add a new template to the repository
    • Find Flow Template by ID
    • Deletes a flow template
    • Update an existing flow template
    • Generate a flow from the flow template
  • Reporting & Monitoring
    • Get Executions
    • Get Logs
  • Webhooks
    • Incoming Webhook
  • Schemas
    • Schemas
      • MutableFlow
      • Status
      • MutableFlowTemplate
      • Flow
      • GlobalRole
      • FlowTemplate
      • FlowGraph
      • Permissions
      • Meta
      • MembershipRole
      • Owner
      • Token
      • ArrayOfIds
      • TokenCreate
      • Login data
      • Register data
      • Tenant Schema
      • Tenant Schema
      • Role
      • MutableRole
      • User body
      • Access token object
      • users' membership in a tenant context
      • User tenant membership
      • User information
      • ArrayOfTenants
      • resetPassword
      • ArrayOfUsers
      • ArrayOfUserTenantContext
    • RequestBodies
      • ArrayOfIds
      • addTenantToFlow
  1. Schemas

FlowGraph

{
    "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"
        }
    ]
}
Built with