This guide will be removed on April 29, 2022. Please use our new, easier-to-use Toast technical documentation site. All updated content is on the new site.

Integrations for all restaurants

Here is the typical integration development process for integrations on the path toward general availability.

Application

The first step toward becoming a Toast partner is to fill out an application for partnership.

The Toast integrations team reviews your application and responds to you with a decision.

Discovery

Toast receives a high volume of applications for partnership and is not able to integrate with all who are interested.

If the Toast integrations team needs more information about your product to determine whether building an integration is a good next step, the Toast integrations team schedules a discovery call with you.

On this call, the Toast integrations team discusses the Toast API functionality with you and determines whether an integration is technically feasible.

Statement of Work and kickoff

If the Toast integration team plans to move forward with integration development for your product, you receive a Statement of Work (SOW) to formalize the partnership.

After the SOW is finalized, your Toast integration contact holds a development kickoff call to discuss the integration development process and the sandbox environment.

Development

After your kickoff call, the Toast integrations team gives you authentication credentials that correspond to your partner API account. You can use these credentials for testing in the sandbox environment.

Once you have sandbox credentials, you can begin to write and test your code.

As you build your integration, refer to our integration development checklists.

Certification

When you are ready to use your integration for live restaurants in the production environment, reach out to your Toast integrations contact to schedule a certification call. The goal of the certification is to make sure that you and the Toast integrations team feel comfortable introducing your integration to initial customers in the production environment (the beta phase).

The Toast team sends you a survey to collect technical information about your integration. You should submit the survey response at least one business day before your certification call.

The certification call is a one-hour, interactive, demo-style review of your integration's workflows. The demo should reproduce as closely as possible the integration experience you will provide in production.

On the call, you discuss:

  • How you interact with each endpoint.

  • How you poll historical data.

  • If applicable, how you send data to the Toast platform.

  • For any restaurant reports, the alignment between your data and the Toast platform data.

If problems or questions arise during the certification call, the Toast team sends an email message that lists the issues. It is your responsibility to resolve the issues before you can receive production credentials.

Beta

After your integration is certified, the Toast integrations team issues production credentials and your integration will enter its beta phase.

You choose 3-5 restaurants or restaurant groups to participate in the beta phase of your integration. Each restaurant should use the integration in the production environment for several weeks. This gives them enough time to become familiar with the integration and to adopt it in their daily workflows. When you allow customers to become early adopters of your integration, make sure that the restaurants understand that they can become early adopters on the condition that they provide feedback about the integration.

The Toast team contacts the beta restaurants to get feedback. If any major issues arise, the Toast team works with you to address them.

Your organization works with the Toast partner marketing team to develop co-marketing activities and integration marketing copy.

General availability

If your beta customers are satisfied with the integration, and your marketing materials are prepared, the Toast integrations team transitions the integration to general availability. In general availability, your integration is listed on the Toast platform public integrations site.

Moving forward, restaurants are able to add your integration through the Toast platform My Integrations page.

After your integration is generally available, the Toast integrations support team helps you to resolve any customer-specific issues that arise.