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

Authorization

apiKey
headerAuthorizationBearer <snoze_sk_…>

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

Path Parameters

workspaceId*string

Request Body

application/json
  1. body
connectionId*string
operation*string
resourceId?string|null
externalType?string|null
externalId?string|null
input?|null
expectedRevision?string|null
confirmed?boolean|null
clientMutationId?string|null

Response Body

Success

application/json
  1. response
data*
Example Request
curl -X POST 'https://api.snoze.dev/v1/workspaces/string/integrations/operations/run' \  -H 'Content-Type: application/json' \  -d '{  "connectionId": "string",  "operation": "string"}'
Example Response
{  "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"  }}

List the provider operations available in a workspace

Returns the operations the workspace's providers expose, including which ones mutate the third-party system and which require explicit confirmation. Requires the `integrations:read` workspace permission.

List recent provider operation runs

Returns the workspace's most recent provider operation runs with their status and results. Requires the `integrations:read` workspace permission. Pass `limit` to cap how many runs come back.