Shopmonkey is connected once at the org level by an admin. The credential is shared across all groups that have been granted access — individual team members don't need to connect their own accounts.
Log in to your Shopmonkey account
Go to Settings → Integrations → API
Generate an API key
Paste the key below
Ready to connect?
Go directly to the integrations page in your dashboard.
These are the data scopes On Belay can be granted for Shopmonkey. Your org admin controls which scopes are enabled per group.
| Scope | Description | Access |
|---|---|---|
appointments:read | Read appointments | Read only |
orders:read | Read orders & invoices | Read only |
customers:read | Read customers | Read only |
vehicles:read | Read vehicles | Read only |
inventory:read | Read inventory | Read only |
payments:read | Read payments | Read only |
Double-check that you copied the full key without any leading/trailing spaces. Some platforms show a truncated preview — make sure to copy the full token. If the key was generated with restricted scopes, verify it includes the permissions listed above.
Check that your group has been granted access to this integration in On Belay → Groups → [your group] → Integrations. Also verify the specific scopes your group is permitted to use match what your query requires.
Some API keys have expiration policies. Generate a new key in Shopmonkey and update it in On Belay → Integrations → Shopmonkey → Update key. Consider creating a dedicated service account or machine user for On Belay so the key isn't tied to a personal account.
Still stuck? We're happy to help.
Contact support →