CRM connector - How to configure
1. Create a CRM connector
Go to your backoffice configuration page and under your Sales channel > CRM:
2. Generate a new hash
Go to your sales channel configuration page and edit the CRM
2.1. When to rotate or update hash keys
Typical situations include:
Security review or policy
Your security team requires regular key rotation for compliance.
Incident or suspected exposure
You suspect the current hash key has been shared with an unintended party or may have been compromised.
Change of vendor, hosting or CRM configuration
The CRM endpoint is moved to a new hosting provider, a new SI/partner takes over, or the code handling the CRM hook is refactored.
You want to ensure only the correct system can validate and respond to the calls coming from OneStock.
Environment alignment
You want to clearly separate keys between sandbox, pre‑production and production, or clean up older keys after a project phase.
2.2. Business impact and precautions
Coordinated change with the CRM owner
Coordinate with the team that maintains the CRM API (internal IT or SI) so they update their configuration with the new hash key at the same time.
Make sure they know where the hash key is configured in their CRM integration code or middleware.
No maintenance window
Previous hash values are sent altogether with new hash. See technical implementation.
Rollback and monitoring
Monitor CRM hook calls (HTTP status, response times, error logs) right after the rotation.
Keep a clear record of the previous key and the new one in your secure vault in case you need to revert quickly (according to your security policies).
Documentation and support
Document which CRM connector had their keys rotated, when, and by whom.
Inform your OneStock contact and your support / operations teams so they can quickly correlate any incident with the rotation.
For large deployments, include hash key rotation steps in your runbooks (go‑live checklist, incident response procedures).
After generating a new hash key with
POST /external_crms/{id}/hash_keys, always share the new value securely with the team managing the CRM hook implementation and make sure the old key is removed from their configuration.
3. Limitations
Currently you can’t setup a single CRM to be used across all your saleschannels.
Make sure to configure the CRM to all sales channels