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.

partner_added

Your integration has been added to a new restaurant location.

Attributes in the partner_added event's payload include:

Value Description

restaurantGuid

A unique Toast POS identifier for the restaurant.

data type: string

format: uuid

managementGroupGuid

A unique Toast POS identifier for a group of restaurants. The management group GUID will be the same for all restaurants within the same group. The management group GUID will be null if a restaurant location does not belong to a restaurant management group.

data type: string

format: uuid

restaurantName

The human-readable name of the restaurant, set on the Restaurant Info screen of the Toast administration back-end.

data type: string

locationName

The name of a specific restaurant location, set on the Restaurant Info screen of the Toast administration back-end. For example, a restaurant group might assign a location name such as Palo Alto or Boston to identify a specific location. Note that this field is not required in Toast, so it may be empty.

data type: string

externalGroupRef

An identifier for the restaurant group that is recognized by the the partner that made the request to the /restaurants endpoint. This information is entered by the restaurant administrator. If you need information about the restaurant group in this data string, you instruct the restaurant administrator to enter it in the Toast POS system configuration for the integration partner connection.

data type: string

externalRestaurantRef

An identifier for the restaurant location that is recognized by the partner that made the request to the /restaurants endpoint. This information is entered by the restaurant administrator. If you need information about the restaurant location in this data string, you instruct the restaurant administrator to enter it in the Toast POS system configuration for the integration partner connection.

data type: string

modifiedDate

The most recent date and time that the partner connection was edited. The date and time are expressed in milliseconds from the UNIX epoch, January 1, 1970 00:00:00 UTC.

data type: string

format: date-time

createdDate

The date and time that the partner connection was created. The date and time are expressed in milliseconds from the UNIX epoch, January 1, 1970 00:00:00 UTC.

data type: string

format: date-time

isoModifiedDate

The most recent date and time that the partner connection was edited. The date and time are expressed in ISO 8601 format.

data type: string

isoCreatedDate

The date and time that the partner connection was created. The date and time are expressed in ISO 8601 format.

data type: string

createdByFirstName

The first name of the restaurant employee who added the integration to the restaurant location.

data type: string

createdByLastName

The last name of the restaurant employee who added the integration to the restaurant location.

data type: string

createdByEmailAddress

The email address of the restaurant employee who added the integration.

data type: string

createdByPhoneNumber

The phone number of the restaurant employee who added the integration.

data type: string

restaurantPhoneNumber

The phone number of the restaurant location.

data type: string

restaurantAddressLine1

The first line of the restaurant's address.

data type: string

restaurantAddressLine2

The second line of the restaurant's address.

data type: string

restaurantCity

The city the restaurant location resides in.

data type: string

restaurantState

The state the restaurant location resides in.

data type: string

restaurantZipCode

The zip code for the restaurant location.

data type: string

Payload example for the partner_added event

{
    "timestamp": “2019-09-16T21:01:53.685Z”,
    "eventCategory": "partner",
    "eventType": "partner_added",
    "guid": "00000000-0000-0000-0000-000000000000",
    "details": {
        "restaurantGuid": "00000000-1111-2222-3333-444444444444",
        "managementGroupGuid": "55555555-6666-7777-8888-999999999999",
        "restaurantName": "Toast Grill & Tap",
        "locationName": "Fenway, Boston, MA",
        "externalGroupRef": null,
        "externalRestaurantRef": null,
        "modifiedDate": 1568667880240,
        "createdDate": 1568667880240,
        "isoModifiedDate": “2019-09-16T21:01:53.685Z”,
        "isoCreatedDate": “2019-09-16T21:01:53.685Z”,
        "createdByFirstName": "Toast",
        "createdByLastName": "Admin",
        "createdByEmailAddress": "admin@toasttab.com",
        "createdByPhoneNumber": null,
        "restaurantPhoneNumber": "6175551234",
        "restaurantAddressLine1": "401 Park Drive"
        "restaurantAddressLine2": null,
        "restaurantCity": "Boston",
        "restaurantState": "MA",
        "restaurantZipCode": "02215"
    }
}