POST api/Toast

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
timestamp	date	None.
eventCategory	string	None.
eventType	string	None.
guid	string	None.
details	Details	None.

Request Formats

application/json, text/json

Sample:

{
  "timestamp": "2025-10-25T21:02:39.7093885+01:00",
  "eventCategory": "sample string 2",
  "eventType": "sample string 3",
  "guid": "sample string 4",
  "details": {
    "restaurantGuid": "sample string 1",
    "order": {
      "guid": "sample string 1",
      "entityType": "sample string 2",
      "externalId": {},
      "revenueCenter": {},
      "server": {
        "guid": "sample string 1",
        "entityType": "sample string 2",
        "externalId": {}
      },
      "createdInTestMode": true,
      "lastModifiedDevice": {
        "id": "sample string 1"
      },
      "source": "sample string 6",
      "voidDate": {},
      "duration": {},
      "businessDate": 9,
      "paidDate": {},
      "restaurantService": {},
      "excessFood": true,
      "voided": true,
      "estimatedFulfillmentDate": "2025-10-25T21:02:39.7093885+01:00",
      "table": {},
      "requiredPrepTime": "sample string 16",
      "approvalStatus": "sample string 17",
      "deliveryInfo": {},
      "serviceArea": {},
      "curbsidePickupInfo": {},
      "numberOfGuests": 21,
      "diningOption": {
        "guid": "sample string 1",
        "entityType": "sample string 2",
        "externalId": {}
      },
      "appliedPackagingInfo": {},
      "openedDate": "2025-10-25T21:02:39.7093885+01:00",
      "voidBusinessDate": {},
      "checks": [
        {
          "guid": "sample string 1",
          "entityType": "sample string 2",
          "externalId": {},
          "displayNumber": "sample string 4",
          "payments": [
            {},
            {}
          ],
          "appliedDiscounts": [
            {},
            {}
          ],
          "lastModifiedDevice": {
            "id": "sample string 1"
          },
          "voidDate": {},
          "paidDate": {},
          "appliedLoyaltyInfo": {},
          "voided": true,
          "paymentStatus": "sample string 9",
          "amount": 10,
          "tabName": {},
          "taxExempt": true,
          "openedDate": "2025-10-25T21:02:39.7093885+01:00",
          "totalAmount": 14,
          "selections": [
            {},
            {}
          ],
          "voidBusinessDate": {},
          "createdDate": "2025-10-25T21:02:39.7093885+01:00",
          "deleted": true,
          "createdDevice": {
            "id": "sample string 1"
          },
          "closedDate": {},
          "deletedDate": "2025-10-25T21:02:39.7093885+01:00",
          "modifiedDate": "2025-10-25T21:02:39.7093885+01:00",
          "taxAmount": 21,
          "appliedServiceCharges": [
            {},
            {}
          ],
          "customer": {}
        },
        {
          "guid": "sample string 1",
          "entityType": "sample string 2",
          "externalId": {},
          "displayNumber": "sample string 4",
          "payments": [
            {},
            {}
          ],
          "appliedDiscounts": [
            {},
            {}
          ],
          "lastModifiedDevice": {
            "id": "sample string 1"
          },
          "voidDate": {},
          "paidDate": {},
          "appliedLoyaltyInfo": {},
          "voided": true,
          "paymentStatus": "sample string 9",
          "amount": 10,
          "tabName": {},
          "taxExempt": true,
          "openedDate": "2025-10-25T21:02:39.7093885+01:00",
          "totalAmount": 14,
          "selections": [
            {},
            {}
          ],
          "voidBusinessDate": {},
          "createdDate": "2025-10-25T21:02:39.7093885+01:00",
          "deleted": true,
          "createdDevice": {
            "id": "sample string 1"
          },
          "closedDate": {},
          "deletedDate": "2025-10-25T21:02:39.7093885+01:00",
          "modifiedDate": "2025-10-25T21:02:39.7093885+01:00",
          "taxAmount": 21,
          "appliedServiceCharges": [
            {},
            {}
          ],
          "customer": {}
        }
      ],
      "deleted": true,
      "createdDevice": {
        "id": "sample string 1"
      },
      "createdDate": "2025-10-25T21:02:39.7093885+01:00",
      "closedDate": {},
      "deletedDate": "2025-10-25T21:02:39.7093885+01:00",
      "modifiedDate": "2025-10-25T21:02:39.7093885+01:00",
      "promisedDate": {},
      "channelGuid": {},
      "pricingFeatures": [
        "sample string 1",
        "sample string 2"
      ]
    }
  }
}

application/xml, text/xml

Sample:

<ToastObject xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ToastWebhook.Models">
  <details>
    <order>
      <appliedPackagingInfo />
      <approvalStatus>sample string 17</approvalStatus>
      <businessDate>9</businessDate>
      <channelGuid />
      <checks>
        <Check>
          <amount>10</amount>
          <appliedDiscounts xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:anyType />
            <d6p1:anyType />
          </appliedDiscounts>
          <appliedLoyaltyInfo />
          <appliedServiceCharges xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:anyType />
            <d6p1:anyType />
          </appliedServiceCharges>
          <closedDate />
          <createdDate>2025-10-25T21:02:39.7093885+01:00</createdDate>
          <createdDevice>
            <id>sample string 1</id>
          </createdDevice>
          <customer />
          <deleted>true</deleted>
          <deletedDate>2025-10-25T21:02:39.7093885+01:00</deletedDate>
          <displayNumber>sample string 4</displayNumber>
          <entityType>sample string 2</entityType>
          <externalId />
          <guid>sample string 1</guid>
          <lastModifiedDevice>
            <id>sample string 1</id>
          </lastModifiedDevice>
          <modifiedDate>2025-10-25T21:02:39.7093885+01:00</modifiedDate>
          <openedDate>2025-10-25T21:02:39.7093885+01:00</openedDate>
          <paidDate />
          <paymentStatus>sample string 9</paymentStatus>
          <payments xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:anyType />
            <d6p1:anyType />
          </payments>
          <selections xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:anyType />
            <d6p1:anyType />
          </selections>
          <tabName />
          <taxAmount>21</taxAmount>
          <taxExempt>true</taxExempt>
          <totalAmount>14</totalAmount>
          <voidBusinessDate />
          <voidDate />
          <voided>true</voided>
        </Check>
        <Check>
          <amount>10</amount>
          <appliedDiscounts xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:anyType />
            <d6p1:anyType />
          </appliedDiscounts>
          <appliedLoyaltyInfo />
          <appliedServiceCharges xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:anyType />
            <d6p1:anyType />
          </appliedServiceCharges>
          <closedDate />
          <createdDate>2025-10-25T21:02:39.7093885+01:00</createdDate>
          <createdDevice>
            <id>sample string 1</id>
          </createdDevice>
          <customer />
          <deleted>true</deleted>
          <deletedDate>2025-10-25T21:02:39.7093885+01:00</deletedDate>
          <displayNumber>sample string 4</displayNumber>
          <entityType>sample string 2</entityType>
          <externalId />
          <guid>sample string 1</guid>
          <lastModifiedDevice>
            <id>sample string 1</id>
          </lastModifiedDevice>
          <modifiedDate>2025-10-25T21:02:39.7093885+01:00</modifiedDate>
          <openedDate>2025-10-25T21:02:39.7093885+01:00</openedDate>
          <paidDate />
          <paymentStatus>sample string 9</paymentStatus>
          <payments xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:anyType />
            <d6p1:anyType />
          </payments>
          <selections xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:anyType />
            <d6p1:anyType />
          </selections>
          <tabName />
          <taxAmount>21</taxAmount>
          <taxExempt>true</taxExempt>
          <totalAmount>14</totalAmount>
          <voidBusinessDate />
          <voidDate />
          <voided>true</voided>
        </Check>
      </checks>
      <closedDate />
      <createdDate>2025-10-25T21:02:39.7093885+01:00</createdDate>
      <createdDevice>
        <id>sample string 1</id>
      </createdDevice>
      <createdInTestMode>true</createdInTestMode>
      <curbsidePickupInfo />
      <deleted>true</deleted>
      <deletedDate>2025-10-25T21:02:39.7093885+01:00</deletedDate>
      <deliveryInfo />
      <diningOption>
        <entityType>sample string 2</entityType>
        <externalId />
        <guid>sample string 1</guid>
      </diningOption>
      <duration />
      <entityType>sample string 2</entityType>
      <estimatedFulfillmentDate>2025-10-25T21:02:39.7093885+01:00</estimatedFulfillmentDate>
      <excessFood>true</excessFood>
      <externalId />
      <guid>sample string 1</guid>
      <lastModifiedDevice>
        <id>sample string 1</id>
      </lastModifiedDevice>
      <modifiedDate>2025-10-25T21:02:39.7093885+01:00</modifiedDate>
      <numberOfGuests>21</numberOfGuests>
      <openedDate>2025-10-25T21:02:39.7093885+01:00</openedDate>
      <paidDate />
      <pricingFeatures xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </pricingFeatures>
      <promisedDate />
      <requiredPrepTime>sample string 16</requiredPrepTime>
      <restaurantService />
      <revenueCenter />
      <server>
        <entityType>sample string 2</entityType>
        <externalId />
        <guid>sample string 1</guid>
      </server>
      <serviceArea />
      <source>sample string 6</source>
      <table />
      <voidBusinessDate />
      <voidDate />
      <voided>true</voided>
    </order>
    <restaurantGuid>sample string 1</restaurantGuid>
  </details>
  <eventCategory>sample string 2</eventCategory>
  <eventType>sample string 3</eventType>
  <guid>sample string 4</guid>
  <timestamp>2025-10-25T21:02:39.7093885+01:00</timestamp>
</ToastObject>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Output

Name	Description	Type	Additional information
Response		boolean	None.
Error		string	None.

Response Formats

application/json, text/json

Sample:

{
  "Response": true,
  "Error": "sample string 1"
}

application/xml, text/xml

Sample:

<Output xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ToastWebhook.Models">
  <Error>sample string 1</Error>
  <Response>true</Response>
</Output>