Plan an API Integration

Evaluate available API capabilities, plan integrations around released behavior, and request improvements.

Use the public API, SDK guides, and endpoint schemas to decide what an integration can do today. Planned behavior should not be a production dependency until it is released and documented.

Integration priorities

The documentation focuses on helping developers:

• choose the correct credential for intake, organization services, and user actions;
• construct requests from public schemas and understand the resulting state;
• distinguish a rejected request from an operation that needs reconciliation; and
• plan SDK upgrades and API migrations with clear release information.

Check whether a capability is available

Look for the operation in the API reference and read its authentication, request, and response requirements. For SDK use, also confirm that your installed package exposes it. The API changelog records released contract changes; the deprecation policy explains retirement notices.

If the contract does not describe a behavior your integration needs, ask support before relying on it. Examples include whether a particular write can be retried safely, whether a delivery is authenticated, and how a resource signals completion.

Request an integration capability

Send [e-mail] the workflow you need to complete, the current limitation, and the consequence for your team. Include the relevant operation or page, expected request volume, and any deadline. Use redacted examples.

A useful request describes the result: “Our CRM needs to reconcile an intake request after a timeout without creating another lead,” for example. That gives the team a concrete requirement to evaluate.

This page does not commit to features or release dates. Use a released contract or a specific written commitment when planning delivery.