SnozeDevelopers
API referenceIntegrations

Run a provider operation through a connection

Executes one registered provider operation against a connection, targeting either a linked resource or an external reference, and returns the run with its status and output. Requires the `integrations:read` workspace permission, and additionally `integrations:write` when the operation mutates the provider; operations marked as requiring confirmation are refused unless the body sets `confirmed`. An unregistered operation is rejected with the provider's registered operation ids named. After a successful run the workspace's cached provider content is dropped and a connector refresh is attempted so native mirrors catch up. Send an `Idempotency-Key` header to make retries safe; a replay within the window returns the original response.

POST
/v1/workspaces/{workspaceId}/integrations/operations/run
AuthorizationBearer <token>

Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.

In: header

Path Parameters

workspaceId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/v1/workspaces/string/integrations/operations/run" \  -H "Content-Type: application/json" \  -d '{    "connectionId": "string",    "operation": "string"  }'
{  "data": {    "id": "string",    "workspaceId": "string",    "connectionId": "string",    "provider": "string",    "operation": "string",    "resourceId": "string",    "status": "running",    "input": {},    "output": {},    "error": "string",    "actorUserId": "string",    "startedAt": "string",    "completedAt": "string"  }}