Applies to: Homebase (Cyncly Websites) — Performance > Leads
Audience: Account admins / anyone configuring lead routing for a company account
Overview
The RFMS integration automatically pushes Homebase leads into RFMS as a Customer (and, optionally, a CRM Opportunity), and reports status back: once a lead's stage in RFMS reaches the pipeline stage you designate as “Won,” that result is reflected back on the lead in Homebase.
Prerequisites
- System Admin access to the Homebase company account you're configuring.
- Your RFMS API Key and Store Queue ID (from RFMS) — see Getting Your RFMS API Credentials below if you don't have these yet.
- An Ad Source value already set up in RFMS that you want Homebase leads tagged with (it must match exactly).
- The name of the RFMS pipeline stage that represents a closed/won sale.
- Homebase locations and RFMS stores already set up on both sides, so they can be mapped to each other.
Getting Your RFMS API Credentials
The API Key and Store Queue ID come from RFMS, not Homebase. Someone with RFMS Administrator access (this is usually the store's RFMS admin, not Cyncly) needs to generate them first. The RFMS API service must be purchased and installed on the account.
- Log in to RFMS Online Services (admin.rfms.online) with an administrator account.
- Select the RFMS Online tile, then click the API button in the upper right corner.
- In the dialog that appears, click Generate Key.
- Choose a Default User — pick someone with broad system permissions. (This doesn't restrict who shows as the salesperson on quotes/customers the integration creates.)
- Enter a Label for the token — something that identifies it as the Homebase/Cyncly integration, so it's recognizable later.
- Click Save.
- Copy the two values shown:
- Store Queue Value (formatted like store-xxx1234) — this is the Store Queue ID.
- API Token (formatted like l3kj5rl34kj5w2l) — this is the API Key.
Enter both values into the RFMS card in Homebase (step 3 below). The same API dialog in RFMS can be reopened later to view existing tokens, generate new ones, or revoke access.
Source: RFMS Help Center — Generate API Credentials for Developers (https://rfmsapps.zendesk.com/hc/en-us/articles/26433251714327-Generate-API-Credentials-for-Developers)
Setup Steps
- Login to your company account in Homebase, then go to Performance → Leads Settings → Integrations.
- Open the RFMS card. Under “Manage Leads Downstream,” click into the RFMS integration.
- Enter your API Key and Store Queue ID. Homebase validates these credentials automatically
- Choose when leads push to RFMS. Set “Push to RFMS when lead status becomes” to the Homebase lead status that should trigger the sync (e.g., Qualified). Leads sync once — the first time they reach that status. Select New status if you want all leads to send automatically.
- Set the Ad Source. This value must exactly match an Ad Source configured in RFMS; leads sent to RFMS will be tagged with it. To find the Source, log into RFMS CRM and open the dropdown menu for Source to find which Source to use for this integration. A source related to the website is ideal.
- Choose what gets created in RFMS: “Create CRM Opportunity and Customer” if RFMS CRM is enabled on the account, or “Create Customer Only” for accounts without CRM enabled.
- Map your locations. Click Edit Store Mappings and match each Homebase location to its corresponding RFMS store.
- Set the Won mapping. Enter the exact RFMS pipeline stage name in “Report as Won status when RFMS stage is” (e.g., Won) — this is what Homebase watches for to mark a lead “Won.”
- Click Save. The RFMS integration is now active for this account.
How Syncing Works
- A lead pushes to RFMS automatically the first time it reaches the status you configured in step 4 (e.g., Qualified) — a one-time push per lead, not a recurring sync.
- To push a lead manually, open it, go to its Integrations tab, and click Sync.
- Once synced, the lead's Log tab shows “Synced,” the last-synced timestamp, and the RFMS Opportunity ID, which links directly to that opportunity in RFMS.
- On the RFMS side, the new Opportunity/Customer is created under the mapped Store, with Source set to your configured Ad Source, and RFMS logs a notification (“Opportunity Created... via API integration”).
Status Flows Back to Homebase
When a lead's stage in RFMS reaches the pipeline stage name you set in step 8 (e.g., “Won”), Homebase reflects that automatically:
- The lead's status badge in Homebase updates to “Won.”
- The Total Sale Amount field populates with the value from RFMS and becomes read-only (“Managed by RFMS and cannot be edited here”).
Notes
- The Ad Source and Won-stage-name fields are exact-match strings — a typo means leads either won't tag correctly or won't report back as Won.
- “Create CRM Opportunity and Customer” only works if RFMS CRM is enabled on the account; otherwise use “Create Customer Only.”