Reservation webhook payload structure

📘

Includes:

guest
financials (required: financials:read scope)
listings (required: listing:read scope)
properties (required: property:read scope)

NOTE: Includes are added automatically based on the scopes that are enabled for your integration

📘

Triggers:

arrival_date departure_date guests status

{
  "action": "reservation.created",
  "created": "2019-01-01T12:00:00Z",
  "version": "v2",
  "id": "9ac091cf-d41f-40fc-98c4-3c239c383cdf",
  "data": {
      "id": "6f58fd0a-a9cb-3746-9219-384a156ff7bb",
      "platform": "homeaway",
      "platform_id": "ABC123",
      "booking_date": "2019-01-01T12:00:00Z",
      "arrival_date": "2019-01-03T00:00:00-05:00",
      "departure_date": "2019-01-05T00:00:00-05:00",
      "check_in": "2019-01-03T13:00:00-05:00",
      "check_out": "2019-01-05T11:00:00-05:00",
      "status": "booking",
      "status_history": [
        {
          "category": "accepted",
          "status": "accepted",
          "changed_at": "2019-01-03T12:00:00-05:00"
        }
      ],
      "house_rules": {
        "pets_allowed": true,
        "smoking_allowed": false
      },
      "guests": {
        "total": 1,
        "adult_count": 1,
        "child_count": 0,
        "infant_count": 0,
        "pet_count": 0
      },
      "financials": {
        "guest": {
          "accommodation": {
            "amount": 12345,
            "currency": "USD",
            "formatted": "$123.45",
            "label": "Accommodation",
            "category": "Accommodation"
          },
          "subtotal": {
            "amount": 12345,
            "currency": "USD",
            "formatted": "$123.45",
            "label": "Subtotal",
            "category": "Subtotal"
          },
          "taxes": [
            {
              "amount": 12345,
              "currency": "USD",
              "formatted": "$123.45",
              "label": "Lodging taxes",
              "category": "Pass-through taxes"
            }
          ],
          "discounts": [
            {
              "amount": 12345,
              "currency": "USD",
              "formatted": "$123.45",
              "label": "Guest Discount",
              "category": "Discount"
            }
          ],
          "adjustments": [
            {
              "amount": 12345,
              "currency": "USD",
              "formatted": "$123.45",
              "label": "Resolution Adjustment",
              "category": "Total payouts"
            }
          ],
          "total_price": {
            "amount": 12345,
            "currency": "USD",
            "formatted": "$123.45",
            "label": "Guest Total Price",
            "category": "Total payment"
          },
          "fees": [
            {
              "amount": 12345,
              "currency": "USD",
              "formatted": "$123.45",
              "label": "Guest Service Fee",
              "category": "Service fees"
            }
          ],
          "total_fees": {
            "amount": 12345,
            "currency": "USD",
            "formatted": "$123.45",
            "label": "Guest Total Fees",
            "category": "Guest fees"
          }
        },
        "host": {
          "accommodation": {
            "amount": 12345,
            "currency": "USD",
            "formatted": "$123.45",
            "label": "Accommodation",
            "category": "Accommodation"
          },
          "accommodation_breakdown": [
            {
              "amount": 12345,
              "currency": "USD",
              "formatted": "$123.45",
              "label": "2024-01-01",
              "category": "Accommodation"
            }
          ],
          "subtotal": {
            "amount": 12345,
            "currency": "USD",
            "formatted": "$123.45",
            "label": "Subtotal",
            "category": "Subtotal"
          },
          "taxes": [
            {
              "amount": 12345,
              "currency": "USD",
              "formatted": "$123.45",
              "label": "City taxes",
              "category": "Host Tax"
            }
          ],
          "discounts": [
            {
              "amount": 12345,
              "currency": "USD",
              "formatted": "$123.45",
              "label": "Guest Discount",
              "category": "Discount"
            }
          ],
          "revenue": {
            "amount": 12345,
            "currency": "USD",
            "formatted": "$123.45",
            "label": "Gross Revenue",
            "category": "Revenue"
          },
          "adjustments": [
            {
              "amount": 12345,
              "currency": "USD",
              "formatted": "$123.45",
              "label": "Resolution Adjustment",
              "category": "Total payouts"
            }
          ],
          "fees": [
            {
              "amount": 12345,
              "currency": "USD",
              "formatted": "$123.45",
              "label": "Cleaning Fee",
              "category": "Guest fees"
            }
          ],
          "total_fees": {
            "amount": 12345,
            "currency": "USD",
            "formatted": "$123.45",
            "label": "Host Total Fees",
            "category": "Guest fees"
          }
        }
      },
      "guest": {
        "email": "[email protected]",
        "phone_numbers": [
          "(507) 256-0697"
        ],
        "first_name": "Beulah",
        "last_name": "Hane"
      },
      "properties": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "name": "Relaxing Villa near the sea",
          "picture": "https://cdn2.thecatapi.com/images/d9m.jpg",
          "address": {
            "number": "32",
            "street": "Senefelderplatz",
            "city": "Berlin",
            "state": "",
            "country": "DE",
            "postcode": "10405",
            "coordinates": {
              "latitude": 50.8514786,
              "longitude": 4.364562
            },
            "display": "37a Senefelderplatz, 10405 Berlin, DE"
          },
          "timezone": "+0200",
          "listed": true,
          "amenities": [
            "shower"
          ],
          "description": "Example Description",
          "summary": "Example Summary",
          "check-in": "12:30",
          "currency": "EUR",
          "capacity": {
            "max": 2,
            "bedrooms": 1,
            "beds": 1,
            "bathrooms": 1
          },
          "room_details": [
            {
              "type": "king_size",
              "quantity": 1
            }
          ],
          "house_rules": {
            "pets_allowed": true,
            "smoking_allowed": false
          },
          "listings": [
            {
              "platform": "airbnb",
              "platform_id": "24488"
            }
          ],
          "tags": [
            "Tag"
          ]
        }
      ],
      "listings": [
        {
          "platform": "airbnb",
          "platform_id": "24488"
        }
      ]
  }
}