Webhooks

This article outlines the information sent in each webhook based on the event type configured in Duve.

The webhook events you receive are only relevant to the sync source that’s live and connected to your Duve account.

Kindly note: Each webhook payload will vary depending on your endpoint, the selected trigger, and the data points you choose. The payload Duve sends will adapt based on these configurations to ensure it aligns with your requirements.

alt text

Available Data Points in Duve webhooks

#Data point#Data Point
1Booking/Reservation ID25PMS External ID
2Estimated Check-In Time26Verified Adults
3Verified First Name27Verified Babies
4Verified Last Name28Verified Email
5Passport Uploaded29Credit Card Uploaded
6Allow Opt-In Marketing30Verified Phone
7Guests Info31Arrival By
8External ID32Flight Origin
9Earliest Check-In Hour33Flight Number
10Latest Check-Out Hour34Skip Stay Payment Step
11Check-In Date35Skipped Signed Document
12Check-Out Date36Purpose of Stay
13Airport Landing37Guest Profiles
14Reservation Link38Preferred Language
15Human Readable39Gallery Link
16Source40Signed Document Name
17Company ID41Paid For Stay
18Is Quick Action42Guest Country
19Client External ID43Check-In Option
20Guest Category Code44Need Transport
21Timezone45Estimated Landing Time
22Custom Fields Answers46Train Station
23External Property ID47Origin
24Estimated Check-In Date-Time48Verified Children

Reservation Created

Example:

1{
2  "accountId": null,
3  "event": "reservationCreated",
4  "resource": {
5    "id": "63bd5f817c1f40e0b093c706",
6    "sId": "-FaCfxErX",
7    "externalId": "123467890",
8    "preCheckInLink": "https://x.duve.co/p/-FaCfxErX",
9    "preCheckOutLink": "https://x.duve.co/c/-FaCfxErX",
10    "guestAppLink": "https://x.duve.co/g/-FaCfxErX"
11  }
12}

Pre Check-in Done

Example:

1{
2  "accountId": "dummy23",
3  "event": "preCheckInDone",
4  "resource": {
5    "id": "6368c383e44d30f1705bd53a",
6    "externalId": "27e19639-ede9-4649-b6aa-aede00c069ce",
7    "estimatedCheckInTime": "22:30",
8    "link": "https://x.duve.com/reservations/6368c383e44d30f1705bd53a",
9    "verifiedEmail": "bsmith@gmail.com",
10    "verifiedPhone": "+1 (435) 364-7744",
11    "verifiedFirstName": "Bobby",
12    "verifiedLastName": "Smith"
13  }
14}

Pre Check-out Updated

Example:

1{
2  "accountId": "dummy23",
3  "event": "preCheckOutUpdated",
4  "resource": {
5    "id": "6368c383e44d30f1705bd53a",
6    "externalId": "27e19639-ede9-4649-b6aa-aede00c069ce",
7    "link": "https://x.duve.com/reservations/6368c383e44d30f1705bd53a",
8    "estimatedCheckOutTime": "11:00",
9    "estimatedCheckOutDateTime": "2023-01-15 11:00"
10  }
11}

Pre Check-out Done

Example:

1{
2  "accountId": "dummy23",
3  "event": "preCheckOutDone",
4  "resource": {
5    "id": "6368c383e44d30f1705bd53a",
6    "externalId": "27e19639-ede9-4649-b6aa-aede00c069ce",
7    "link": "https://x.duve.com/reservations/6368c383e44d30f1705bd53a",
8    "checkOutScore": {
9      "cleanScore": 4,
10      "propertyScore": 4,
11      "staffScore": 3
12    },
13    "checkOutReview": "test",
14    "estimatedCheckOutTime": "11:00"
15  }
16}

Guest Document Uploaded

Example:

1{
2  "accountId": "dummy23",
3  "event": "guestDocumentUploaded",
4  "resource": {
5    "id": "6368c383e44d30f1705bd53a",
6    "externalId": "27e19639-ede9-4649-b6aa-aede00c069ce",
7    "documents": [
8      {
9        "name": "document1.pdf",
10        "uploadDate": "2023-01-11T08:40:09.419Z",
11        "dtype": "2"
12      }
13    ]
14  }
15}

Example:

1{
2  "accountId": "",
3  "event": "guestLinkOpened",
4  "resource": {
5    "id": "6368c383e44d30f1705bd53a",
6    "externalId": "27e19639-ede9-4649-b6aa-aede00c069ce",
7    "guestLink": "
8https://t.duve.co/p/5F0Ypwr8q5"
9  }
10}

Order Created

Example:

1{
2  "accountId": "6368c35588d770ea9b0ae2e1",
3  "event": "orderCreated",
4  "resource": {
5    "id": "6368c383e44d30f1705bd53a",
6    "externalId": "27e19639-ede9-4649-b6aa-aede00c069ce",
7    "order": {
8      "id": "63be7b757c2370fadee27bd1",
9      "orderId": 16800,
10      "status": 0,
11      "chargeAmount": 90,
12      "currency": "USD"
13    }
14  }
15}

Order Cancelled

Example:

1{
2  "accountId": "6368c35588d770ea9b0ae2e1",
3  "event": "orderCancelled",
4  "resource": {
5    "id": "6368c383e44d30f1705bd53a",
6    "externalId": "27e19639-ede9-4649-b6aa-aede00c069ce",
7    "order": {
8      "id": "63be7b757c2370fadee27bd1",
9      "status": 3,
10      "chargeAmount": 90,
11      "currency": "USD"
12    }
13  }
14}

Guest Message

Example:

1{
2  "accountId": "[companyId]",
3  "event": "chatMessageSent",
4  "resource": {
5    "id": "[converstationChatId]",
6    "messageContent": "Hello",
7    "author": "Host",
8    "sentAt": "2023-01-01T12:34:56Z"
9  }
10}

Order Refunded

Example:

1{
2  "accountId": "6368c35588d770ea9b0ae2e1",
3  "event": "orderRefunded",
4  "resource": {
5    "id": "6368c383e44d30f1705bd53a",
6    "order": {
7      "id": "63be7cfb7c2370fadee28251",
8      "refundTotal": 100,
9      "numOfRefundsMade": 1
10    }
11  }
12}
Built with