Check for an existing connection
If you want to bring data from a supported PSA or RMM into Lexful, check the integration catalog first. A custom integration is useful when you need a workflow or data source that the available connections do not cover.
Define the workflow
Decide which system owns each field, which organizations and asset types are involved, and whether the workflow creates records, updates them, or reads them.
Keep a stable mapping between source records and Lexful record IDs. Before creating a record, decide how the integration will recognize one it has already processed. Do not assume repeated create requests are automatically deduplicated.
Set up authentication
Create a dedicated, clearly named key in Platform → API keys and store its credentials securely. Follow the API authentication guide to exchange the Key ID and Secret for a token, then send the token and the correct account header with your requests.
Run credential-bearing code in a trusted backend or automation service. Avoid embedding a secret in a browser application or a shared script. Coordinate secret rotation with the integration's operator and test authentication after replacing it.
Build against the current API
Use developer.lexful.ai for endpoint paths, supported operations, required fields, pagination, and error responses.
Map source values to the target asset type's actual fields.
Follow pagination when reading lists.
Handle expired credentials and access errors explicitly.
Back off on throttling or temporary service failures.
Check whether a write succeeded before retrying it.
Record enough context to diagnose failures without logging secrets or sensitive field values.
Only rely on webhook events, delivery guarantees, or other integration features when they are explicitly documented for the endpoint or product you are using.
Test a small, controlled workflow
Start with a read request to confirm the account and permissions. Then use clearly identified test records in an agreed test location to check creation, update, error handling, and recovery.
Confirm the resulting records in Lexful. Re-run the same source item to check your duplicate handling, and make sure the integration cannot accidentally write into another organization's records.
Do not run bulk writes or destructive cleanup against customer data as an initial test. Agree on test data and its cleanup before rollout.
Operate and troubleshoot
Monitor successful runs as well as failures. Keep track of the last completed work so an interrupted run can resume safely.
When requesting help, include the endpoint, operation, time, HTTP status, and any request identifier returned. Remove tokens, secrets, and sensitive payload values. Support can help clarify Lexful behavior; your integration's scheduling, transformations, and retry logic remain part of your implementation.