Orchesty.io 2.0 API

openapi: 3.1.0
info:
  title: Orchesty.io 2.0 API
  version: '2026-10-18'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-18: 8 operation(s) read from 5 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Orchesty.io has published no machine-readable contract that the
    pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 10
    documentation: 24
    pages-with-code: 8
    pages-read: 13
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-18'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://orchesty.io/docs/2.0/getting-started/connector
  - https://orchesty.io/docs/2.0/getting-started/custom-node
  - https://orchesty.io/docs/2.0/getting-started/installation
  - https://orchesty.io/docs/2.0/getting-started/retry-policy
  - https://orchesty.io/docs/2.0/getting-started/webhooks
  x-docs-section: '2.0'
paths:
  /Orchesty/Installer/main/InstallScript.sh:
    get:
      operationId: get_Orchesty_Installer_main_InstallScript_sh
      tags:
      - Orchesty
      summary: GET /Orchesty/Installer/main/InstallScript.sh
      x-source: https://orchesty.io/docs/2.0/getting-started/installation
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -fsSL https://raw.githubusercontent.com/Orchesty/Installer/main/InstallScript.sh)\"\n This is the recommended method for\
          \ quick setup. Startup and Login into Orchesty Admin # Using the make init-dev command, we start and download the Docker image, which\
          \ sets up the database and starts all important services. make init-dev\n Orchesty Admin represents the user interface for design and\
          \ control of pr"
  /connector/my-connector/action/test:
    post:
      operationId: post_connector_my_connector_action_test
      tags:
      - Connector
      summary: POST /connector/my-connector/action/test
      x-source: https://orchesty.io/docs/2.0/getting-started/connector
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostConnectorMyConnectorActionTestRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl http://localhost:8080/connector/my-connector/action/test\n Execute connector: curl -X POST http://localhost:8080/connector/my-connector/action\
          \  -H \"Content-Type: application/json\"  -d '{\"customerId\": \"123\"}'\n Related Concepts # Custom Node - For data transformation\
          \ without API calls Authentication - How to use Applications with connectors Data Flow - Understanding ProcessDto lifecycle Error Ha"
  /custom-node/data-transformer/action:
    post:
      operationId: post_custom_node_data_transformer_action
      tags:
      - Custom Node
      summary: POST /custom-node/data-transformer/action
      x-source: https://orchesty.io/docs/2.0/getting-started/custom-node
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostCustomNodeDataTransformerActionRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST http://localhost:8080/custom-node/data-transformer/action  -H \"Content-Type: application/json\"  -d '{\n \"customerId\"\
          : \"123\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"emailAddress\": \"john@example.com\"\n }'\n Best Practices # 1. Keep\
          \ Nodes Focused # //Good - single responsibility\n class EmailValidatorNode extends ACommonNode { }\n class PhoneValidatorNode extends\
          \ ACommonNode { }"
  /custom-node/list:
    get:
      operationId: get_custom_node_list
      tags:
      - Custom Node
      summary: GET /custom-node/list
      x-source: https://orchesty.io/docs/2.0/getting-started/custom-node
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: curl http://localhost:8080/custom-node/list
  /data:
    get:
      operationId: get_data
      tags:
      - Data
      summary: GET /data
      x-source: https://orchesty.io/docs/2.0/getting-started/retry-policy
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDataResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl/RequestDto' ;\n import {HttpMethods} from '@orchesty/nodejs-sdk/lib/Transport/HttpMethods' ;\n export default class ApiCallConnector\
          \ extends AConnector {\n public getName () : string {\n return 'api-call' ;\n }\n public async processAction ( dto : ProcessDto ) :\
          \ Promise < ProcessDto > {\n const requestDto = new RequestDto (\n 'https://api.example.com/data' ,\n HttpMethods. GET ,\n dto\n );"
  /webhook/applications/shopify/users/test@example.com:
    get:
      operationId: get_webhook_applications_shopify_users_test_example_com
      tags:
      - Webhook
      summary: GET /webhook/applications/shopify/users/test@example.com
      x-source: https://orchesty.io/docs/2.0/getting-started/webhooks
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: curl http://localhost:8080/webhook/applications/shopify/users/test@example.com
  /webhook/applications/shopify/users/test@example.com/subscribe:
    post:
      operationId: post_webhook_applications_shopify_users_test_example_com_subscribe
      tags:
      - Webhook
      summary: POST /webhook/applications/shopify/users/test@example.com/subscribe
      x-source: https://orchesty.io/docs/2.0/getting-started/webhooks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostWebhookApplicationsShopifyUsersTestExampleComSubscribeRe'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST http://localhost:8080/webhook/applications/shopify/users/test@example.com/subscribe  -H \"Content-Type: application/json\"\
          \  -d '{\"name\":\"order-created\",\"topology\":\"order-processing\"}'\n Simulating Webhook Events # # Send test webhook"
  /webhook/topologies/topo-123/nodes/node-456/token/abc123def456:
    post:
      operationId: post_webhook_topologies_topo_123_nodes_node_456_token_abc123def456
      tags:
      - Webhook
      summary: POST /webhook/topologies/topo-123/nodes/node-456/token/abc123def456
      x-source: https://orchesty.io/docs/2.0/getting-started/webhooks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostWebhookTopologiesTopo123NodesNode456TokenAbc123Def456Req'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST https://orchesty.example.com/webhook/topologies/topo-123/nodes/node-456/token/abc123def456  -H \"Content-Type:\
          \ application/json\"  -d '{\n \"event\": \"order.created\",\n \"order_id\": \"12345\",\n \"total\": 150.00\n }'\n Using Webhook Testing\
          \ Tools # RequestBin : Capture and inspect webhook requests Ngrok : Tunnel localhost for testing Postman : Send mock webhook payloads\
          \ Webhook.site : Online webho"
components:
  schemas:
    PostConnectorMyConnectorActionTestRequest:
      type: object
      properties:
        customerId:
          type: string
    PostCustomNodeDataTransformerActionRequest:
      type: object
      properties:
        customerId:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        emailAddress:
          type: string
    GetDataResponse:
      type: object
      properties:
        repeater:
          type: object
          properties:
            enabled:
              type: boolean
            interval:
              type: integer
            hops:
              type: integer
    PostWebhookApplicationsShopifyUsersTestExampleComSubscribeRe:
      type: object
      properties:
        name:
          type: string
        topology:
          type: string
    PostWebhookTopologiesTopo123NodesNode456TokenAbc123Def456Req:
      type: object
      properties:
        event:
          type: string
        order_id:
          type: string
        total:
          type: number
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      x-source: https://orchesty.io/docs/3.0/development/authentication-and-settings/authentication-and-settings
    OAuth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://auth.wflow.com/oauth/authorize
          tokenUrl: https://auth.wflow.com/oauth/token
          scopes:
            read_invoices: ''
            write_invoices: ''
      x-source: https://orchesty.io/docs/3.0/development/authentication-and-settings/authentication-and-settings
tags:
- name: Connector
- name: Custom Node
- name: Data
- name: Orchesty
- name: Webhook
security:
- Bearer: []
- OAuth2:
  - read_invoices
  - write_invoices