Workflow guide
Plan an integration
Document the interface and failure behavior before connecting systems.
Confirm the enabled version and permissions in your environment. These guides do not announce a general release.
Before you start
An API environment, a valid identity, a flow definition and credentials for only the providers the flow needs. Use the environment-specific OpenAPI contract.
Steps
- Record the environment, product version, responsible owner and permitted data. Keep credentials outside the document.
- Confirm the input/output schema, authentication, timeouts and retry ownership with the receiving system. Pin the adapter or API version used for the test.
- Exercise a missing permission and an unavailable dependency in a test environment. Ensure a retry cannot repeat a completed change.
Check the result
Compare the observed outcome with the expected result. Keep the relevant identifier and a redacted record so a colleague can review the same case.
If it does not work
Use run, flow and correlation identifiers to distinguish input validation, model/provider, tool and worker failures. Confirm run state before retrying.