Sandbox & Production

You build and test your integration against a Sandbox company instance, then run it for real against a Production instance. Sandbox is a property of a company instance, not a separate copy of Everee. Your Sandbox and Production instances are separate Company instances (see Company instances & multiple EINs), so nothing you create in Sandbox appears in Production, and the other way around.

What's the same, and what's separate

Both environments use the same API domain, https://api.everee.com, for every request. That includes creating embedded experience URLs. They also share the same admin portal, https://app.everee.com. Nothing in a URL selects the environment. The API token and tenant ID you send on each request decide which instance the request acts on, and the company instance you choose in the admin portal decides which one you're working in.

Everything else is separate for each environment:

	Sandbox	Production
API domain	`https://api.everee.com`	`https://api.everee.com`
Admin portal URL	`https://app.everee.com`	`https://app.everee.com`
Company tenant ID	Its own	Its own
API token	Its own	Its own
Webhook endpoints and signing keys	Its own	Its own
Workers, payments, and other data	Its own	Its own
Admin portal access	Users must be added to the Sandbox instance	Users must be added to the Production instance

An API token works only with the instance it was created in. If you send a token with the other environment's tenant ID, the request fails.

Set up your Sandbox

Get your Sandbox tenant ID. Ask your Everee Customer Success manager or [email protected] which tenant ID is your Sandbox, and make a note of it.
Create a Sandbox API token. Sign in to the admin portal at https://app.everee.com with access to the Sandbox instance. Open Integrations Hub, find Everee API, and create a token. Confirm the "Company tenant ID" shown there is your Sandbox tenant ID. See Authentication & API tokens.
Create a Sandbox webhook endpoint. In the same Everee API section, add an endpoint for your test environment. Each instance can have up to three endpoints, and Everee generates a separate signing key for each. See Authenticating events.
Store each environment's credentials separately. Keep the tenant ID, API token, webhook endpoint, and signing key together as one set per environment, and select the set by configuration, not in code. Never reuse any of them across environments.

Avoid mixing environments

Check the tenant ID before you test. A request acts on whichever instance its tenant ID and token belong to. If you send your Production values, you create real workers and real payroll activity.
Check where an event came from. Every webhook event includes the companyId of the instance that sent it. Use it to reject events from an unexpected instance.
Expect configuration to differ. Features and company settings are enabled for each instance separately, so Sandbox and Production can differ. If something works in one and not the other, contact support.
Remove test data from Production. If you created test workers in Production by mistake, contact support and we'll help you clean them up.

Test data and payments in Sandbox

Test worker data. Sandbox accepts made-up values. It doesn't check the format of a Social Security number, and a bank routing number doesn't need to exist in the bank directory. Use a nine-digit routing number and any account number.
No real money moves. A payment in Sandbox never sends funds.
Payments reach Paid only after approval. Every payment waits for a payroll admin to approve it. Payments don't progress to Paid on their own unless auto-approval is turned on for the Sandbox instance. Auto-approval is off by default. Ask your Everee Customer Success manager to turn it on.

Moving to Production

Your code needs no changes to its URLs. Switch to the Production tenant ID, API token, webhook endpoint, and signing key, and test again. If you're building an integration for multiple Everee customers, Everee reviews it before it's approved for live customers.