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
- Find the operation in the reference and confirm method, path, required parameters, types, and response schema.
- Prepare an authorization with the required scope and transmit credentials according to the endpoint contract.
- Check resource access. For workflows, identify the version and Start inputs.
- Send a minimal mock request and inspect response status and redacted errors.
- If the response includes a task or call reference, continue checking execution state or call records.
- 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
| Stage | Action |
|---|---|
| Authentication failure | Check credential and environment without logging the full token |
| Permission failure | Inspect operation scope and resource grants |
| Invalid parameters | Compare names, types, and required fields |
| Execution failure | Locate the failed node and service error |
| Network timeout | Check 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.