PartnerAccessExternalWebhookRep

Information about a Toast platform restaurant.

• createdByEmailAddress:
  string

  The email address of the restaurant employee who connected the restaurant to your integrated partner service, or who edited the connection details.

• createdByFirstName:
  string

  The first name of the restaurant employee who initiated the event.

• createdByLastName:
  string

  The last name of the restaurant employee who initiated the event.

• createdByPhoneNumber:
  string

  The phone number of the user who initiated the event.

• createdDate:
  string <date-time>

  The date and time that the partner connection was created in epoch time (milliseconds since 1970-01-01 00:00:00).

• externalGroupRef:
  string

  An identifier for the restaurant group that is recognized by your integrated partner service. 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 platform configuration for the integration partner connection.

• externalRestaurantRef:
  string

  An identifier for the restaurant location that is recognized by your integrated partner service. 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 platform configuration for the integration partner connection.

• isoCreatedDate:
  string

  The date and time that the partner connection was created in ISO8601 format.

• isoModifiedDate:
  string

  The most recent date and time that the partner connection was edited in ISO8601 format.

• locationName:
  string

  The identifier of a specific restaurant location, set on the Restaurant Info page of Toast Web. For example, a restaurant group might assign a location code such as Location1234 to a specific location.

• managementGroupGuid:
  string <uuid>

  The unique Toast platform identifier for the management group containing the restaurant.

• modifiedDate:
  string <date-time>

  The most recent date and time that the partner connection was edited in epoch time (milliseconds since 1970-01-01 00:00:00).

• restaurantAddressLine1:
  string

  The physical address of the restaurant location.

• restaurantAddressLine2:
  string

  Optional additional physical address of the restaurant location.

• restaurantCity:
  string

  The city in which the restaurant is located.

• restaurantGuid:
  string <uuid>

  The unique Toast platform identifier for the restaurant.

• restaurantLatitude:
  string

  The latitude of the restaurant location.

• restaurantLongitude:
  string

  The longitude of the restaurant location.

• restaurantName:
  string

  The human-readable name of the restaurant location.

• restaurantPhoneNumber:
  string

  The phone number of the restaurant.

• restaurantState:
  string

  The state in which the restaurant is located.

• restaurantZipCode:
  string

  The zip code of the restaurant location.

{
  "restaurantGuid": "e728cd53-2fa7-4e63-8f8f-93e78ea66b03",
  "managementGroupGuid": "bdfda703-2a83-4e0f-9b8a-8ea0ee6cab79",
  "restaurantName": "string",
  "locationName": "Location1234",
  "externalGroupRef": "string",
  "externalRestaurantRef": "string",
  "modifiedDate": 1678846869551,
  "createdDate": 1643858534451,
  "isoModifiedDate": "2023-03-12T08:32:34.008Z",
  "isoCreatedDate": "2022-05-17T10:21:38.008Z",
  "createdByFirstName": "Clemence",
  "createdByLastName": "Lefebvre",
  "createdByEmailAddress": "[e-mail]",
  "createdByPhoneNumber": 9876543210,
  "restaurantPhoneNumber": 8765432109,
  "restaurantAddressLine1": "123 Main Street",
  "restaurantAddressLine2": "Suite 321",
  "restaurantCity": "Gatineau",
  "restaurantState": "Massachusetts",
  "restaurantZipCode": 1234,
  "restaurantLatitude": "string",
  "restaurantLongitude": "string"
}