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

{
  "action": "reservation.created",
  "created": "2019-01-01T12:00:00Z",
  "version": "v2",
  "id": "9ac091cf-d41f-40fc-98c4-3c239c383cdf",
  "data": {
    "id": "d04d1803-8011-35b5-abee-93188bd4b20e",
    "platform": "airbnb",
    "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": "accepted",
    "house_rules": {
      "pets_allowed": true,
      "smoking_allowed": false,
      "events_allowed": null
    },
    "guests": {
      "total": 1,
      "adult_count": 1,
      "child_count": 0,
      "infant_count": 0,
      "pet_count": 0
    },
    "financials": {
      "guest": {
        "accommodation": null,
        "cleaning_fee": null,
        "security_deposit": null,
        "service_fee": {
          "amount": 10000,
          "formatted": "$100.00",
          "currency": "USD",
          "label": "Guest Service Fee",
          "category": "Service fees"
        },
        "subtotal": null,
        "taxes": [
          {}
        ],
        "total_price": {
          "amount": 12345,
          "currency": "USD",
          "formatted": "$123.45",
          "label": "Guest Total Price",
          "category": "Total payment",

        },
        "fees": [
          {
            "amount": 10000,
            "formatted": "$100.00",
            "currency": "USD",
            "label": "Guest Service Fee",
            "category": "Service fees"
          },
          {
            "amount": 12345,
            "formatted": "$123.45",
            "currency": "USD",
            "label": "Pet Fee",
            "category": "Guest fees"
          },
          {
            "amount": 10000,
            "formatted": "$100.00",
            "currency": "USD",
            "label": "Linen Fee",
            "category": "Guest fees"
          }
        ],
        "total_fees": {
          "amount": 32345,
          "formatted": "$323.45",
          "currency": "USD",
          "label": "Guest Total Fees",
          "category": "Guest fees"
        }
      },
      "host": {
        "accommodation": null,
        "cleaning_fee": null,
        "payout": null,
        "service_fee": {
          "amount": 10000,
          "formatted": "$100.00",
          "currency": "USD",
          "label": "Guest Service Fee",
          "category": "Service fees"
        },
        "subtotal": {
          "amount": 12345,
          "currency": "USD",
          "formatted": "$123.45",
          "label": "Subtotal",
          "category": "Subtotal"
        },
        "taxes": [],
        "fees": [
          {
            "amount": -10000,
            "formatted": "-$100.00",
            "currency": "USD",
            "label": "Host Service Fee",
            "category": "Service fees"
          },
          {
            "amount": 12345,
            "formatted": "$123.45",
            "currency": "USD",
            "label": "Pet Fee",
            "category": "Guest fees"
          },
          {
            "amount": 10000,
            "formatted": "$100.00",
            "currency": "USD",
            "label": "Linen Fee",
            "category": "Guest fees"
          }
        ],
        "total_fees": {
          "amount": 12345,
          "formatted": "$123.45",
          "currency": "USD",
          "label": "Host Total Fees",
          "category": "Guest fees"
        }
      }
    },
    "guest": {
      "email": "[email protected]",
      "phone_numbers": [
        "1-937-287-9188"
      ],
      "first_name": "Autumn",
      "last_name": "Mosciski"
    },
    "properties": [
      {
        "id": "12345",
        "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",
          "oven"
        ],
        "description": "Example Description",
        "check-in": "12:30",
        "currency": "EUR",
        "capacity": {
          "max": 2,
          "bedrooms": 1,
          "beds": 1
        },
        "features": {
          "sync": false,
          "heartbeats": false,
          "stealth": false
        }
      }
    ],
    "listings": [
      {
        "platform": "airbnb",
        "platform_id": "24488"
      }
    ]
  }
}