Integration and API

Call Studio APIs from external systems

Find the operation in the API reference, configure authorization and send a request. Workflow calls also require inputs and a version.

Integration checks

  1. Find the operation in the reference and confirm method, path, required parameters, types, and response schema.
  2. Prepare an authorization with the required scope and transmit credentials according to the endpoint contract.
  3. Check resource access. For workflows, identify the version and Start inputs.
  4. Send a minimal mock request and inspect response status and redacted errors.
  5. If the response includes a task or call reference, continue checking execution state or call records.
  6. Verify outputs, writes, and duplicate-request handling before production calls.

Acceptance and completion

A synchronous business result differs from asynchronous acceptance. Interpret API responses according to the endpoint documentation.

Failure handling

StageAction
Authentication failureCheck credential and environment without logging the full token
Permission failureInspect operation scope and resource grants
Invalid parametersCompare names, types, and required fields
Execution failureLocate the failed node and service error
Network timeoutCheck server-side execution before retrying a write

Logs and redaction

Integration logs should support correlation, but public documentation uses mock references and payloads. Remove dedicated Webhook URLs, authorization tokens, real file IDs, and customer inputs.