Actions

Run an action

post

Runs an action for the specified action key, customer integration ID and user ID

Authorizations

x-api-key

x-api-keystringRequired

Body

application/json

keystringRequired

The key of the action to run

Example: action-1

customerIntegrationIdstringRequired

The customer integration ID to use for the action

Example: integration-1

userIdstringRequired

The ID of the user who is running the action

Example: user-123

inputobjectOptional

Input parameters for the action. Required if action has input schema defined.

Example: {"name":"John Doe"}

passThroughobject[]Optional

Pass through data for the action run, e.g. credentials for the integrations used in the run

Example: [{"customerIntegrationId":"integration-1","headers":{"Authorization":"Bearer 1234567890"}}]

Responses

200

Action run successfully. Returns runId and output in the shape of action's output schema

application/json

401

Unauthorized - invalid API key

post

/v1/actions/run

HTTPcURLJavaScriptPython

POST /v1/actions/run HTTP/1.1
Host: api.toolregistry.ai
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 212

{
  "key": "action-1",
  "customerIntegrationId": "integration-1",
  "userId": "user-123",
  "input": {
    "name": "John Doe"
  },
  "passThrough": [
    {
      "customerIntegrationId": "integration-1",
      "headers": {
        "Authorization": "Bearer 1234567890"
      }
    }
  ]
}

{
  "runId": "123e4567-e89b-12d3-a456-426614174000",
  "output": {}
}