Integration Troubleshooting
Common issues when connecting SalesOS with external tools, and how to resolve them.API Connection Issues
401 Unauthorized
Symptom: API returns401 Unauthorized for every request.
Causes and solutions:
Token expired
Token expired
JWT tokens expire after 24 hours. Request a new token using your client credentials or refresh token. See the Authentication guide.
Token missing or malformed
Token missing or malformed
Ensure the Authorization header is formatted as
Bearer YOUR_TOKEN (with a space after “Bearer”). Do not include quotes around the token.Wrong audience
Wrong audience
When requesting a token, the
audience parameter must be https://api.play2sell.com. An incorrect audience generates a valid token that SalesOS does not accept.Revoked API client
Revoked API client
Your API client may have been deleted or deactivated by an administrator. Check Admin > Integrations > API Keys to verify.
403 Forbidden
Symptom: API returns403 Forbidden for specific endpoints.
Solution: Your API client does not have the required scope. Edit the API client in Admin > Integrations > API Keys and add the necessary scopes (e.g., leads:write, deals:read).
429 Too Many Requests
Symptom: API returns429 after many rapid requests.
Solution: You have exceeded your rate limit. Implement these strategies:
- Check the
Retry-Afterheader for when you can resume - Add delays between requests (especially in loops)
- Use pagination efficiently — fetch larger pages to reduce total requests
- Cache responses where possible
- Consider upgrading your plan for higher limits
Webhook Issues
Webhooks Not Firing
If you are not receiving webhook events:Check event subscriptions
Confirm you are subscribed to the correct event types. A webhook set to
deal.won will not fire for deal.created.Check the delivery log
Open the webhook details and review the delivery log. Failed deliveries show the HTTP status code and error message from your server.
Webhook Receiving Duplicate Events
Cause: Retries due to slow or failed responses from your server. Solution:- Ensure your server responds with
200within 10 seconds - Use the event
idfield for deduplication - Process payloads asynchronously — respond immediately, handle the data in a background job
Webhook Auto-Deactivated
Cause: 10 consecutive delivery failures automatically deactivate the webhook. Solution:- Fix the underlying issue with your endpoint
- Go to Admin > Integrations > Webhooks
- Reactivate the webhook
- Test with a manual event to confirm it works
SalesOS Connect (n8n) Issues
Workflow Not Triggering
- Verify the workflow is set to Active (toggle is on)
- Check that the trigger node is correctly configured
- For webhook triggers, ensure the webhook URL in SalesOS matches the n8n webhook node URL
- Check n8n execution log for errors
Workflow Fails Mid-Execution
- Open the failed execution in the n8n execution log
- Click the failed node to see the error details
- Common issues:
- Authentication expired — Update credentials in the n8n node
- Invalid data format — Add a transformation node to fix data mapping
- External service unavailable — Add error handling with a retry mechanism
n8n Credential Errors
If n8n cannot authenticate with SalesOS:- Go to the n8n credential settings
- Update the SalesOS API token
- Test the connection
- Re-run the failed workflow
Omie ERP Issues
Connection Test Fails
- Verify your Omie App Key and App Secret are correct
- Ensure your Omie account is active and has API access enabled
- Check if Omie is experiencing downtime (check their status page)
Client Registration Fails
- Verify the CNPJ/CPF is valid (correct number of digits, valid check digits)
- Ensure all required fields are filled: name, CNPJ/CPF, address
- Check if the client already exists in Omie (duplicate CNPJ)
NFS-e Issuance Fails
Common errors:| Error | Solution |
|---|---|
| Invalid service code | Select a valid service code from your Omie configuration |
| Client not found | Register the client in Omie first using pay-cadastrar-cliente |
| Tax authority unavailable | Wait and retry — municipal systems have scheduled maintenance |
| Invalid tax configuration | Review your tax regime settings in Omie with your accountant |
General Troubleshooting Steps
If none of the specific solutions above help:- Check the SalesOS status page for any ongoing incidents
- Review recent changes — Did someone modify API keys, webhook URLs, or integration settings?
- Test with minimal configuration — Create a simple test (e.g., a single API call) to isolate the issue
- Check logs — Review webhook delivery logs, n8n execution logs, and your server logs
- Contact support — Include error messages, request IDs, and reproduction steps

