Start with the workflow
Describe the system you want to connect, the records involved, and whether Soffyt should send, receive, or both. Include the expected frequency and who will own the integration. A one-time customer migration may be covered by CSV import; a mailbox or document workflow may already have a connection.
Check the existing connections firstCurrent API scope
Soffyt’s initial versioned API supports an organization-scoped, read-only customer listing. API access must be configured and provisioned for the company. A normal employee login is not an integration credential, and the website does not provide self-service API-key creation. Confirm the supported contract and access with the team before implementation.
Access and data boundaries
Integration credentials are limited to their organization and granted scopes and are subject to rate limits. Confirm which fields are needed and keep credentials in your server’s protected configuration. Do not place a key in a public website, browser code, shared document, or support message.
Writes and event delivery
Do not assume that a workflow in the Soffyt interface is also available as a public API write operation. For webhook or event-driven work, confirm the available events, authorization, delivery and retry behavior, and duplicate handling with the team. There is no self-service webhook subscription guide on this website.
What to send with an integration request
A short description is enough to start. Use fictional examples rather than customer exports or credentials.
- The source and destination systems.
- The records and fields that need to move.
- Whether you need a one-time import, regular updates, or event-driven delivery.
- The result you expect when a record changes, a transfer fails, or a duplicate is found.