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.

Message data schema

Webhook messages are always sent as JSON payloads in the body of POST requests. The message is sent with Content-Type: application/json.

Regardless of the event category, the data in the message that is published to your endpoint follows the same schema:

    "timestamp": “<ISO formatted timestamp in UTC>”,
    "eventCategory": "<eventCategory>",
    "eventType": "<eventType>",
    "guid": "<eventGuid>",
    "details": {
        <eventType specific payload>

For reference information on the payload returned for specific event categories, see Webhooks reference.