Before you start
- A Marxel organization admin account
- A Breezy administrator account with API access
- A Breezy Pro plan for automatic candidate updates
Check your access
Breezy Personal Access Tokens are available to accounts with API access. An administrator can create and manage the token from their Breezy user settings.
Automatic candidate updates use Breezy webhooks, which Breezy documents as a Pro feature. You can still connect Breezy and run manual syncs on an account without webhook access.
Create a Personal Access Token
- 1. In Breezy, select your profile icon in the left sidebar, then open My Settings.
- 2. Select API Keys, then select + Create API Key.
- 3. Give the key a clear name such as Marxel and choose an expiration period.
- 4. Select Create Key, copy the token, then close the dialog.
Find your Breezy company ID
Marxel needs the Breezy company that owns the positions you want to sync. Breezy exposes company records through the GET /v3/companies endpoint.
Find your company in the response and copy its _id value. Marxel also accepts Breezy's friendly_id and normalizes it to the company's internal ID when you connect.
Connect Breezy HR in Marxel
- 1. Open Organization settings, Integrations.
- 2. Find Breezy HR, then enter the Company ID and API token from the previous steps.
- 3. Select Connect. Marxel checks that the token can access the supplied company before saving the connection.
Credential handling
Marxel encrypts the Breezy credentials before storing them. The token is not returned to the browser after connection.
Confirm automatic updates
During connection, Marxel attempts to create a Breezy webhook endpoint for candidateAdded and candidateStatusUpdated events. You do not need to create this endpoint manually in Breezy.
Breezy webhook access requires Pro. If Breezy rejects webhook creation, Marxel keeps the connection active for manual sync and tells you that automatic candidate updates are not enabled. Upgrade to Pro, then reconnect Marxel to try again.
Sync positions and candidates
- 1. Open the Breezy HR card menu in Marxel and select Sync jobs.
- 2. Marxel imports Breezy positions and their candidates, including available resume links.
- 3. Run another sync after adding positions or candidates when automatic updates are not available.
Manual sync is always available
A successful Breezy connection does not depend on webhook provisioning. If your account does not include Breezy Pro, use Sync jobs whenever you want Marxel to refresh positions and candidates.
Troubleshooting
Breezy rejects the credentials
Check that the company ID belongs to the same Breezy account as the token. If the token has expired or was revoked, create a new one and reconnect Marxel.
The connection works but updates do not arrive
Automatic candidate updates require Breezy Pro. If you have Pro, reconnect Marxel so it can retry webhook creation, then confirm that the connection completed without the manual-sync warning.
A position or candidate is missing
Run Sync jobs from the Breezy HR card and confirm that the position belongs to the company ID you connected. Marxel checks every Breezy position state during a sync.
You need to replace the token
Create a replacement Personal Access Token in Breezy before disconnecting the existing connection. Reconnect Marxel with the new token and the same company ID.
Ready to connect?
Keep this guide open while you create the Breezy token and complete the integration card in Marxel.
Open integrations