Create webhook

curl -X POST https://sandbox.duve.com/api/openapi/v1/webhooks \
     -H "Authorization: Bearer {token}" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "My Duve Connect webhook",
  "event": "reservationCreated",
  "url": "https://example.com/duve/webhooks",
  "conditions": [
    {
      "filterType": 1,
      "op": "="
    }
  ],
  "dataPoints": [
    "externalId",
    "preCheckInLink"
  ],
  "isEnabled": true,
  "headers": [
    {
      "key": "X-Wishbox-Auth-Token",
      "value": "<token>"
    }
  ]
}'

{
  "_id": "string",
  "name": "string",
  "event": "string",
  "url": "string",
  "conditions": [
    {
      "filterType": 1,
      "op": "string"
    }
  ],
  "dataPoints": [
    "string"
  ],
  "isEnabled": true,
  "headers": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "brands": [
    "string"
  ],
  "valueNameToCompare": "string",
  "notifyOnWebhookFailures": true,
  "failureNotificationEmails": [
    "string"
  ]
}

Create an outgoing Duve Connect webhook configuration for your company.

Required fields include name, event, and url. Optionally configure conditions, data points, headers, brand scoping, and email notifications for failures. For reservationDetailsUpdated, you can set valueNameToCompare to target ETA, ETD, or stayDateChanged.

Request

This endpoint expects an object.

namestringRequired

eventstringRequired

Event key. See Appendix - Webhook events.

urlstringRequired

conditionslist of objectsOptional

dataPointslist of stringsOptional

See Appendix - Webhook data points.

isEnabledbooleanOptionalDefaults to true

headerslist of objectsOptional

brandslist of stringsOptional

Brand ids (ObjectId as string) to limit delivery

valueNameToComparestringOptional

Used for specific events like reservationDetailsUpdated to target ETA/ETD/stayDateChanged

notifyOnWebhookFailuresbooleanOptional

Email notification on webhook failures

failureNotificationEmailslist of stringsOptional

Email addresses to notify on webhook failures

Response

Created successfully

_idstringOptional

namestringOptional

eventstringOptional