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.

Partners webhook

The partners webhook allows you to receive updates when:

  • Your integration is added to a restaurant location.

  • Your integration is removed from a restaurant location.

  • Your integration's settings in the Toast POS system are updated, for example, when the externalGroupRef or externalRestaurantRef property is updated.

When a message is published to your webhook endpoint for the partner event category, the eventCategory value is set to partner and the eventType is set to one of the following:

The updates published through the partner event category are in addition to the emails you currently receive when your integration is added to or removed from a restaurant location. For more information about how to trigger a webhook event in the partner category, see this Toast Central article.