Partner Hub

Overview

Partner Hub is Otter's new workspace for partners who build integrations with Otter's APIs. It's where you set up your integration, get the credentials to connect your systems to Otter, and test everything in a safe sandbox before you go live.

With Partner Hub, you're able to:

• Create an application for your integration and work in its sandbox workspace
• Get and manage the API credentials that connect your systems to Otter
• Set up webhooks so your systems are notified when events happen
• Test against stores that Otter provisions for you
• Review your requests, responses, and delivery results in logs, without needing to submit a support ticket
• See configuration changes made by your team in one place

Partner Hub Login
Partner Hub is currently invitation only. You will receive an email with further instructions to set up your account

Partner Hub Features 

Partner Hub puts the tools you need to build and test an Otter integration in one place, so you can move faster and troubleshoot on your own. The sandbox gives you a testing environment before you request production access, so you can build and test with confidence before anything touches a live restaurant.

Process Overview

Once you have your login, here's the path from sign-in to testing:

• Activate your account, add your business, and create a sandbox application
• Get oriented on the home page
• Get and create your API credentials
• Set up webhooks
• Use your test stores and sign in to Otter Dashboard and Order Manager
• Review your integration logs

When you're ready to go live, certification, billing, and production access are handled with your Otter contact. Partner Hub doesn't activate production on its own at this stage.

1. Activate set up your account 

After Otter adds you as a user, follow this sequence: invitation email, set password, sign in, add business, create sandbox application.

Step	Process	Image
1	Open the invitation email. Look for the email from no-reply@notify.tryotter.com with the subject Set up your Otter Partner Hub account, then select Set your password.
2	Set your password and sign in. Enter and confirm your password, then select Set password. Sign in using the email address that was invited.
3	Add your business. Follow the prompts to add your business to Partner Hub.

If you have any issues with the Otter User in Square, reach out to Square Support to get help.

2. Create your Sandbox Application

Your application is where you develop and test your integration. It lives in the sandbox, so nothing you do here affects live restaurants.

Step	Process	Image
1	Open the application switcher and select Add application.
2	Choose the application type: Orders, Point of sale, or Delivery.
3	Enter an Application name and Description.
4	Select all applicable Operating countries, then select Create.

3. Navigating Home Page

The home page is your starting point. It shows your setup progress and points you to the places you'll use most: keys, webhooks, test stores, and guides.

Some checklist items on the home page reflect later steps in the integration journey, such as going live. They don't mean you can certify or move to production on your own.

Step	Process	Image
1	Review your application workspace. The home page introduces your setup progress and links to keys, webhooks, test stores, and guides.
2	Check your context. The application switcher and environment selector show which application and environment you're working in. Confirm both before making changes.

4. Get & Create API Credentials 

API Client IDs and secrets authenticate your integration's requests to Otter. They are different from the credentials you use to sign in to Otter Dashboard and Order Manager.

Step	Process	Image
1	Open Keys. Confirm you're in the right application and the Sandbox environment. Your default Client ID is visible and the secret is masked. Use the copy button to copy the Client ID.
2	Create additional credentials. Select Create credential and enter a unique alias (up to 100 characters). Separate credentials are useful for independent systems, such as bots or CI. Select Create credential to confirm.
3	Save your secret. Copy the secret from the confirmation screen and store it somewhere secure, then select Done. NOTE: The secret is shown only once. After you select Done, you won't be able to view it again. If you lose it, regenerate it. Each saved credential shows a masked secret and the time it was created, with options to regenerate or revoke it individually.

5. Set Up Webhooks 

Webhooks send event notifications from Otter to your receiving system.

Step	Process	Image
1	Enter endpoint details. Open Webhooks and select Add webhook. Enter a description and your HTTPS endpoint URL.
2	Choose authentication. Select the method your receiver requires: Basic authentication, Bearer token, HMAC SHA-1, or no additional authentication.
3	Choose events. Search or expand the event groups and select the events you want to subscribe to.
4	Choose delivery state. Set Enable webhook based on whether delivery should start right away, then select Add webhook.
5	Review your configuration. The list shows event count, authentication, last delivery, and status. Open a webhook to see its endpoint, masked webhook secret, authentication, delivery toggle, and subscribed events. Tip: To test delivery, set up a working receiver, enable the webhook, and use Send test event.

Each event can belong to only one webhook. If an event is already assigned to another webhook, it won't appear in the picker, even if that webhook is disabled.

6. Sign in to Otter Dashboard using test stores

Test stores let you build and test against realistic store setups. Otter Dashboard and Order Manager (OM) are the tools you'll use to see and manage those test stores and their orders.

Your Otter Dashboard/Order Manager login is separate from your API Client ID and secret. API credentials authenticate your integration's calls. Otter Dashboard/Order Manager credentials are for signing in to the test-store tools.

7. Review Integration Logs

Logs show what's happening between your systems and Otter, so you can troubleshoot without waiting on a support ticket.

Step	Process	Image
1	Find activity. Open Logs. Today is selected by default. Choose a recent date range, or set a custom date and time range, to look at earlier activity.
2	Narrow it down. Filter by operation and status, or search by external store ID, order ID, or event ID.
3	Inspect a request or response. Open a row's actions and select Open payload. You'll see the event context, request URL and body, response status and body, and duration.
4	Get your BM/OM login. You'll receive login credentials for your test Share or save it. Use Copy JSON or Download JSON.

If Today is empty, there may simply be no activity yet. Try a wider date range.

8. Additional Partner Hub Tabs 

These are the other areas you can use to manage your integration and keep track of your team.

Partner Hub Tab	What you'll find	Image
Users	Account members, names, roles, and invitation status. Search by name or email. The actions available to you depend on your permissions.
Team Activity	A record of security and configuration changes, including credential creation, secret regeneration, settings changes, and webhook changes. Search by user, action, message, or level.
App Settings	Your application name and description, OAuth Client ID, redirect URL, authorization-code-flow setting, and grouped scopes. Select Edit to make changes if you have permission.
Documentation	API guides, quickstart, certification-readiness roadmaps for your scenario, API reference, and webhook-security guidance.
Operations: Stores	Available stores, operational metrics, date ranges, filters, and searchable store details.   The Operations: Stores view is separate from your test stores. If you don't have any stores yet, or there's no activity in the selected period, these views will be empty.
Operations: Orders	Order metrics, with filters for period, store, or POS injection status. Search by full order ID.

FAQs

• Not at this time. Otter creates partner accounts and adds users. Once you're added, you'll get an email invitation to set your password, add your business, and create a sandbox application.
•  
•  
• No. API credentials authenticate your integration's calls. BM/OM credentials are used to sign in to the test-store tools.
• Not yet. Certification, billing, and production access are handled with your Otter contact.
• The event is already assigned to another webhook. Each event can belong to only one webhook, including webhooks that are disabled.
• Secrets are shown only once when they're created. Open Keys and regenerate the secret for that credential.
• Select Forgot password on the Partner Hub sign-in page to set a new password.

Still have questions? Reach out to your Otter Contact. 

Updated November 04, 2026 18:43