The Toast developer portal allows you to easily view and manage your credentials and scopes, access technical documentation, and connect with the Toast integration community.
To use the developer portal, you need:
-
To be a Toast partner
-
A production Toast developer portal account
Note
Your developer portal account is created by the Toast Partner Connect team. For more information, see Toast Partner Connect - Setting Up Integrations with Toast.
Once your developer portal account is created by the Toast Partner Connect team, you will receive a welcome email from Toast with a link to activate and set up your account.
To activate your developer portal account
-
In the developer portal account welcome email, select the Set up your account button. The account activation page in the Toast developer portal opens.
-
Enter your password and select the Activate button to save your password and activate your developer portal account.
-
Select the Login now button. Your account is activated and you are logged in. You can also login to the developer portal through this link.
On the developer portal home page, you can:
-
View API operational status
-
View technical documentation
-
View cookbooks
-
View the Developer guide
-
View API references
-
View the Platform guide
-
View API and Platform release notes
-
-
Visit the Toast Integrations Community Forum
-
View and manage your credentials
-
View your connected restaurants
-
View and manage your webhooks
-
Submit feedback
The following image shows the Toast developer portal home page.
The API status button on the top navigation bar allows you to view the real-time operational status of Toast's APIs and an incident history.
The Documentation button on the top navigation bar opens the Technical Documentation site. The site has links to various documentation resources useful for integration developers.
The Community button on the top navigation bar opens the Toast Integrations Community Forum. In the forum, you can read announcements and news, ask questions, and submit feature requests.
The Credentials page contains your API credentials. Your API credentials grant you access to Toast resources and allow you to securely send API requests. For more information about credentials, see Authentication and restaurant access.
The Credentials page contains your client name, client ID, and client secret. To copy your client name or client ID, select the Copy button to copy your information to your clipboard. To rotate your client secret, select the Rotate button and follow the instructions on the page. Listed under the client secret is the date and time, and email address of the Toast user who last modified the client secret.
|
Note |
|
Rotating your client secret terminates the existing client secret for Toast API access and creates a new client secret to replace it. The active authentication token generated using your credentials is valid until it expires or is replaced with a new authentication token. |
The Scopes page contains the API scopes associated with your developer portal account. Access to Toast APIs, specific endpoints, and specific API endpoint operations is controlled by the scopes that are associated with your client credentials. For more information, see Scopes.
The API access endpoint is the endpoint you can use to access Toast's production environment. For more information, see Environments.
The Connected Restaurants page displays all the restaurant locations that are added and connected to your integration.
The Partner Connect marketplace listing page is where you can edit the details of your Toast Partner Connect listing. Toast Partner Connect is Toast's integration management portal. For more information about Toast Partner Connect, see Set Up Toast Partner Connect.
To edit your integration's listing
-
On the Toast Partner Connect marketplace listing page, select the Edit details button. This opens the Partner Connect marketplace listing page.
-
On the Partner Connect marketplace listing page, you can edit your integration's listing on Toast Partner Connect by:
-
Adding or removing an image
-
Editing your integration's description
You can only edit your integration's listing on Toast Partner Connect in the Production environment. You cannot edit your integration's listing in the Sandbox environment.
-
-
Select the Submit button to save your changes or the Back button to go back to the home page.
|
Note |
|
Your integration's description and image are visible to all Toast customers who subscribe to Toast Partner Connect. |
To get help with your integration's listing or to visit the Toast Integrations Community Forum, select the Open a support ticket link.
The Webhooks page displays all your webhook subscriptions and their statuses, webhook subscription GUIDs, webhook event categories, and additional information. For more information about webhooks, see Webhooks reference.
On the Webhooks page, you can view and edit details about a webhook or add a new webhook subscription.
On the Webhooks page, you can view details about your webhook subscription. To view details, select the webhook link or the View button. This opens the Webhooks events page where you can view the follow details:
-
Webhook name
-
Notification email address
-
Webhook URL
-
Webhook status
-
Event category
-
Secret key. For more information, see Message signing
To view additional details about a webhook event, select its webhook GUID link. This opens the Event details dialog box. In the Event details dialog box, you can view the following information:
-
Webhook GUID: The identifier of the webhook. The GUID is unique per event subscription.
-
Webhook URL: The URL of the webhook consumer service that receives the webhook events.
-
Subscription GUID: This identifies the partner and the event category.
-
Event category: The classification for the type of events the webhook sends.
-
Event type: The name of the specific type of webhook event.
-
Event GUID: The identifier of the webhook event. The GUID is unique per webhook event.
-
Webhook event status.
-
Date and time of the webhook event.
-
Number of webhook attempts.
-
Response code.
-
Route key.
-
Signature. For more information, see Message signing.
-
Webhook request body.
From the Webhook events page, you can choose to filter events associated with your webhook subscription.
To filter webhook events
-
On the Webhooks events page, select the Filters button to open the Filters panel. You can filter using the following options:
-
Webhook event status:
-
All
-
Success
-
Pending
-
Not sent
-
Failure
-
-
Date range
-
Time period
-
-
Select the Apply filters button to apply the filters. This displays a list of webhook event results. Each webhook event result displays the following information and available actions:
-
Webhook GUID. This is the identifier of the webhook. The GUID is unique per event subscription.
-
Date and time the webhook event was initially sent to the webhook URL.
-
Number of webhook attempts. For more information about retry attempts, see Retry support.
-
Webhook response code.
-
Webhook event status.
-
Replay button. This requests the webhook message be resent.
-
|
Note |
|
You can edit webhook details on the Edit webhook page. You can navigate to the Edit webhook page by selecting the Edit button next to the webhook link on Webhooks page or by selecting the Edit webhook button on the Webhook events page. |
From the Edit webhook page, you can edit details about your webook subscription.
To edit webhook details
-
Navigate to the Edit webhook page from the Webhooks page or from the Webhooks events page.
-
On the Edit webhook page, you can edit the following fields:
Note
The event category cannot be edited.
-
Webhook URL
-
Webhook name
-
Notification email address
-
-
Select the Save button to save your changes, the Cancel button to close out of the page, or the Delete button to be directed to open a support ticket with the Developer Relations team.
From the Webhooks page, you can add a new webhook subscription.
To add a new webhook subscription
-
On the Webhooks page, select the +Add webhook button. This opens the Add webhook page.
-
On the Add webhook page, complete the following fields:
-
Event category: Select your event category from the drop-down. For more information, see Webhooks reference.
-
Webhook URL: Enter the URL of the webhook consumer service that receives the webhook events.
-
Webhook name: The name is automatically populated after you select the Event category.
-
Notification email: This is the email address that messages and notifications are sent to if Toast experiences an outage, breakage, or delays with webhook endpoints. For more information, see Back-off support.
-
-
Select the Save button to save your changes or the Cancel button to close out of the page.
You can provide feedback on the Toast developer portal by selecting the Support tab on the left navigation pane. This opens the Toast Integrations Community Forum where you can submit a request.