Copy Markdown

What you'll accomplish

Connect Zapier to solarOS and build a Zap that creates a Lead from any trigger: a web form, a spreadsheet row, another app's webhook, and thousands of other Zapier-supported sources.

Prerequisites

• The Owner or Admin role, to create an API key.
• An API key with exactly these scopes: leads:write, campaigns:read, lead_sources:read, sales_types:read, team_members:read. Zapier's connection test checks for all five before it will connect.
• Access to the private solarOS Zapier app invite: see step 2.

Steps

1. Create an API key for Zapier

Follow Create and manage API keys and webhooks to create a key. Choose Limited access and add exactly the five scopes listed above (leads:write, campaigns:read, lead_sources:read, sales_types:read, team_members:read). Setting a Key owner is recommended; it becomes the default Lead owner when a Zap doesn't specify one.

2. Open the private Zapier app

solarOS's Zapier integration is a private app, not a public listing. It only works through an invite link. The current one, as of this writing, is: https://zapier.com/developer/public-invite/245775/510562/9c54223bc3f99eb989c93edba992e2a0/.

TODO(owner): invite link. This link is version-scoped and must be reissued every time the app's version changes (packages/zapier/README.md §Deploy). Confirm it's current before sending it to anyone; if it 404s, ask whoever manages the integration for the current one.

3. Connect your account

In Zapier, add a new solarOS connection and paste in the API key from step

1. Zapier calls solarOS to verify it, and the connection is labeled with your organization's name once it succeeds.

4. Build a Zap with Create Lead

Add solarOS's Create Lead action to your Zap and map fields from your trigger:

• First Name, Last Name (required), Email, Phone
• Street Address, City, State, Zip Code
• Campaign, Lead Source, Sales Types: these dropdowns are populated live from your solarOS data.
• Lead Owner: leave blank to use the API key's default Lead owner.
• Notes
• Submission ID: map your trigger's unique ID (e.g. a form entry ID). This prevents duplicate leads if the same submission retries, and links the lead back to its source.

5. Test and turn on the Zap

Run the Zap's test step, then publish it.

Verify it worked

• Triggering the Zap creates a Lead in Sales → Leads with the Campaign, Lead Source, and Sales Type you mapped.
• Re-running the same submission (same Submission ID) doesn't create a duplicate lead.

Common problems

• Connection fails with "This solarOS API key is missing required scopes: <scopes>. Open the key in solarOS under Settings → Integrations → API Keys, grant those scopes, then reconnect." (<scopes> is a placeholder: Zapier fills in the actual comma-separated list of missing scopes.) Open the key under Settings → Integrations → API Keys, add those scopes, then reconnect. Don't create a new key: reconnecting re-runs the check against the same key.
• Campaign / Lead Source / Sales Types dropdowns are empty. The key is missing campaigns:read, lead_sources:read, or sales_types:read; under-scoped keys connect but their dropdowns silently return nothing. Add the scope and reconnect.
• Leads show up without the source you expected. Double-check the mapping in the Zap step: Campaign and Lead Source are separate fields and are easy to swap.