Before you start
Create a dedicated personal access token and store it outside source control. You need the permissions required by the operations your integration will call.
1. Open the API documentation
From Agent setup, open OpenAPI explorer or OpenAPI JSON. Read the current request fields, response schemas and authentication requirements for the operation you need.
2. Set authentication and context
Send the bearer token as an Authorization header. Use the documented discovery operations to find the permitted company, workspace and provider account identifiers. Do not copy identifiers from another brand’s examples.
3. Test reads before writes
Start with a read-only request and verify its account context. Handle errors and asynchronous statuses explicitly. Before retrying a write with an uncertain result, check whether the intended action already happened.
4. Use Copy bootstrap if you need a ready-made setup
Copy bootstrap in Agent setup creates a separate token for that integration. Use it when you intend to create those credentials, then store the resulting secret securely. It is not just a copy of public documentation.
Check the result
Confirm the integration’s read result and permissions before allowing the integration to publish, send messages or make other changes. Keep the API schema as the source of truth for fields and supported operations.
If something does not work
For an authentication error, check the token and header. For an authorization error, check company membership and permissions. For validation errors, compare the request with the current OpenAPI schema.