Execute Runner - Crego APIs

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

id

string

required

Example:

a0b2a8cb-bbc2-46cc-b00a-2313b9115a87

Body Params application/json

action

enum<string>

required

Allowed values:

submitnavigate

data

object

required

Additional properties

integer | number | string | boolean

optional

Example

{
    "action": "submit",
    "data": {
        "gst_no": "06AAK4577H1Z8a"
    }
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://preprod.api.crego.io/v1/rego/runners/a0b2a8cb-bbc2-46cc-b00a-2313b9115a87/execute/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "action": "submit",
    "data": {
        "gst_no": "06AAK4577H1Z8a"
    }
}'

Responses

🟢200Success

application/json

Body

Preset representing an operation in a flow.

id

string <uuid>

ID

required

A unique identifier, typically a UUID.

Example:

123e4567-e89b-12d3-a456-426614174000

company_id

string

Company ID

optional

Unique identifier of the company to which it belongs.

Example:

comp-12345

element

object (Base Node)

required

Node representing an operation in a flow.

name

string

Node Name

required

The name of the node. Defaults to a generated name if not provided.

Examples:

Node1Node2

type

enum<string>

Node Type

required

Defines the type of the node (e.g., 'code_snippet', 'web_form').

Allowed values:

code_snippetweb_formnotificationapi_requestflow_connectorchecklistcsv_importtaskweb_page

Examples:

code_snippetweb_form

config

Node Configuration

required

Configuration details specific to the node.

permissions

array [object {2}]

required

edges

array [object {5}]

required

Tags

optional

description

string

optional

created_by

string

Created By

required

The identifier of the user who created the edge. Must be 5-20 characters, allowing alphanumeric, dots, underscores, and dashes.

Match pattern:

"^[a-zA-Z0-9._-]{3,50}$"

updated_by

string | null

Updated By

optional

The identifier of the user who updated the edge. Must be 5-20 characters, allowing alphanumeric, dots, underscores, and dashes.

Match pattern:

^[a-zA-Z0-9._-]{3,50}$

created_at

string <date-time>

Created At

required

ISO 8601 timestamp when this was created.

Example:

2024-11-27T00:00:00Z

updated_at

string <date-time> | null

Updated At

optional

ISO 8601 timestamp when the node was last updated.

Example:

2024-11-27T01:00:00Z

Example

{
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "company_id": "comp-12345",
    "element": {
        "name": "Node1",
        "type": "code_snippet",
        "config": {
            "code": "def greet(name):\n    return f\"Hello, {name}!\""
        },
        "permissions": [
            {
                "roles": [
                    "string"
                ],
                "actions": [
                    "string"
                ]
            }
        ],
        "edges": [
            {
                "action": "string",
                "type": "return",
                "target_node": "string",
                "config": {
                    "condition": "string"
                },
                "return": {
                    "data": {},
                    "transformer": "jmes"
                }
            }
        ]
    },
    "tags": [
        "string"
    ],
    "description": "string",
    "created_by": "string",
    "updated_by": "string",
    "created_at": "2024-11-27T00:00:00Z",
    "updated_at": "2024-11-27T01:00:00Z"
}