Toast

this guide walks you through the process of finding your toast api credentials to establish a connection with bindbee before you begin before you begin, confirm that the following requirements are met requirement what it means active employee access the user creating the credentials must be an active employee of the toast location for which api access is being configured rms essentials subscription each location included in the integration must have an active toast restaurant management suite (rms) essentials subscription or higher locations without the required subscription appear with a lock icon and cannot be selected contact your toast account representative to confirm your subscription tier "manage integrations" permission the user creating the credentials must have the 8 4 manage integrations permission enabled for every location included in the credential set this permission is required to view and manage api credentials creating api credentials in toast web 1\ open the manage credentials page sign in to toast web and navigate to integrations → toast api access → manage credentials the icon displayed next to each credential indicates your level of access no icon full access warning icon read only access lock icon no access to view or edit the credential you must have full access to create and manage the credential set used for the bindbee integration 2\ create a new standard api credential select create new credentials , then choose standard api from the dropdown 3\ configure the credential on the new credentials page, configure the credential name, api scopes, and locations enter a recognizable credential name, such as bindbee integration select the required api scopes listed below select the locations that bindbee should access select apply to confirm the selected locations you can select all locations within the management group or select individual locations if a location is disabled and displays a lock icon, it does not have the required rms essentials subscription or higher and cannot be added to the credential required scopes configure the following scopes scope why we need it labor employees\ read employee records labor\ read jobs, time entries and related labor data attached to each employee restaurants\ read location names and identifiers, so we can map records to the right site 4\ confirm the credential and save the client secret select confirm to create the credential after the credential is created the new credential appears on the manage credentials page toast sends a confirmation email containing the names and guids of the enabled locations copy and securely store the client secret when it is displayed important toast displays the client secret only once if the secret is lost, you must rotate it and provide the new value to bindbee information required to connect toast open the credential from the manage credentials page by selecting the pencil icon enter the following details into the bindbee magic link value where to find it client id credentials page, "copy client id" client secret shown once at creation, or after rotating the secret api access url credentials page, "copy api access url" credential management keep the following considerations in mind after the integration is configured secret rotation requires the connector to be relinked if the client secret is rotated, bindbee must be updated with the new credentials before synchronization can resume locations must be explicitly added to the credential adding a new location to toast does not automatically grant the existing credential access to it update the credential in toast when additional locations need to be included credential access depends on location level permissions the user managing the credential must have the required permissions for every location associated with it troubleshooting i cannot see the manage credentials page your toast user may not have the 8 4 manage integrations permission ask a toast administrator or restaurant operator with the required access to enable it under employees → employee management → employees → jobs & permissions a location is greyed out with a lock icon when i try to select it that location does not have access to toast restaurant management suite (rms) essentials or higher an active rms essentials or higher subscription is required to enable standard api access for the location my credential displays a warning icon and cannot be edited the credential is available with read only access because the user does not have the 8 4 manage integrations permission for every location associated with the credential enable the permission for all included locations to restore full credential management access i lost the client secret open the credential in toast web and select rotate copy the new client secret when it is displayed and provide it to bindbee so the connector can be relinked