Skip to main content
POST
/
connectors
/
{connectorId}
/
actions
/
{actionId}
/
execute
Execute Connector Action
curl --request POST \
  --url https://production.runalloy.com/connectors/{connectorId}/actions/{actionId}/execute \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: <x-api-version>' \
  --data '
{
  "credentialId": "507f1f77bcf86cd799439011",
  "requestBody": {},
  "additionalHeaders": {},
  "queryParameters": {},
  "pathParams": {}
}
'
{
  "success": true,
  "result": {
    "messageId": "1234567890"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.runalloy.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-api-version
string
default:2025-09
required

API version

​
x-alloy-userid
string

The ID of the user executing the action; If not provided, the request will be made as the API Key user

Path Parameters

​
connectorId
string
required

Connector ID

​
actionId
string
required

Action ID

Body

application/json
​
credentialId
string
required

Valid credential ID (must be a valid ObjectId)

Example:

"507f1f77bcf86cd799439011"

​
requestBody
object

Request body data for the action

​
additionalHeaders
object

Additional headers to include in the request

​
queryParameters
object

Query parameters for the request

​
pathParams
object

Path parameters for the request

Response

200 - application/json

Action executed successfully