Custom Integrations

Add any REST API as a custom integration.

Configuration

In config.json

{
  "customIntegrations": [
    {
      "name": "myapi",
      "baseUrl": "https://api.example.com",
      "auth": {
        "type": "bearer",
        "token": "{{env.MY_API_KEY}}"
      },
      "actions": {
        "getData": {
          "method": "GET",
          "path": "/data"
        },
        "postData": {
          "method": "POST",
          "path": "/data",
          "body": "{{params}}"
        }
      }
    }
  ]
}

In integrations/ directory

Create integrations/myapi.json:

{
  "name": "myapi",
  "baseUrl": "https://api.example.com",
  "auth": {
    "type": "bearer",
    "token": "{{env.MY_API_KEY}}"
  },
  "actions": {
    "getUser": {
      "method": "GET",
      "path": "/users/{{params.userId}}"
    },
    "createUser": {
      "method": "POST",
      "path": "/users",
      "body": {
        "name": "{{params.name}}",
        "email": "{{params.email}}"
      }
    }
  }
}

Authentication Types

Bearer Token

{
  "auth": {
    "type": "bearer",
    "token": "{{env.API_KEY}}"
  }
}

Basic Auth

{
  "auth": {
    "type": "basic",
    "username": "{{env.API_USER}}",
    "password": "{{env.API_PASS}}"
  }
}

API Key Header

{
  "auth": {
    "type": "header",
    "name": "X-API-Key",
    "value": "{{env.API_KEY}}"
  }
}

Query Parameter

{
  "auth": {
    "type": "query",
    "name": "api_key",
    "value": "{{env.API_KEY}}"
  }
}

Action Definition

{
  "actions": {
    "actionName": {
      "method": "GET|POST|PUT|PATCH|DELETE",
      "path": "/endpoint/{{params.id}}",
      "headers": {
        "Custom-Header": "value"
      },
      "body": {
        "field": "{{params.field}}"
      },
      "query": {
        "filter": "{{params.filter}}"
      }
    }
  }
}

Using in Routes

{
  "path": "/my-endpoint",
  "method": "post",
  "integrations": [{
    "type": "myapi",
    "action": "createUser",
    "params": {
      "name": "{{body.name}}",
      "email": "{{body.email}}"
    }
  }]
}

Using in Workflows

{
  "id": "sync-user",
  "steps": [
    {
      "id": "create",
      "type": "integration",
      "integration": "myapi",
      "action": "createUser",
      "params": {
        "name": "{{input.name}}",
        "email": "{{input.email}}"
      }
    }
  ]
}

Full Example

{
  "name": "weather",
  "baseUrl": "https://api.weather.com",
  "auth": {
    "type": "query",
    "name": "appid",
    "value": "{{env.WEATHER_API_KEY}}"
  },
  "defaultHeaders": {
    "Accept": "application/json"
  },
  "actions": {
    "getCurrent": {
      "method": "GET",
      "path": "/current",
      "query": {
        "city": "{{params.city}}",
        "units": "metric"
      }
    },
    "getForecast": {
      "method": "GET",
      "path": "/forecast",
      "query": {
        "city": "{{params.city}}",
        "days": "{{params.days}}"
      }
    }
  }
}

Response Handling

Integration responses are available in:

• Routes: Returned as response
• Workflows: {{steps.stepId.result}}

{
  "id": "get-weather",
  "type": "integration",
  "integration": "weather",
  "action": "getCurrent",
  "params": { "city": "London" }
}

Access result:

{
  "id": "format",
  "type": "transform",
  "input": "{{steps.get-weather.result.temperature}}"
}