Notifications

Manage notification subscriptions for booking, availability, and product updates

To use this capability, add octo/notifications to your Octo-Capabilities header.

All paths below are shown under /octo.

Supported Notification Types

• BOOKING_UPDATE

• AVAILABILITY_UPDATE

• PRODUCT_UPDATE

notificationTypes are case-insensitive in requests and returned as uppercase values in responses.

Create Subscription

post

Body

application/json

From capability octo/notifications.

notificationTypestringOptional

Notification type value.

Example: booking_update

notificationTypesstring[]Optional

List of notification type values.

Example: ["STANDARD"]

urlstring · uriOptional

Fully-qualified URL.

Example: https://www.city-sightseeing.com

activebooleanOptional

Whether active is enabled.

Example: true

retryOnErrorbooleanOptional

Whether retry on error is enabled.

Example: true

Responses

200

Successful response

application/json

post

/notifications/subscriptions

HTTPcURLJavaScriptPython

POST /octo/notifications/subscriptions HTTP/1.1
Host: api.ventrata.com
Content-Type: application/json
Accept: */*
Content-Length: 185

{
  "notificationType": "booking_update",
  "notificationTypes": [
    "STANDARD"
  ],
  "url": "https://www.city-sightseeing.com",
  "headers": {
    "X-Webhook-Secret": "abc123"
  },
  "active": true,
  "retryOnError": true
}

200

Successful response

{
  "subscriptionId": "sub_booking_update_01",
  "notificationType": "booking_update",
  "notificationTypes": [
    "STANDARD"
  ],
  "url": "https://www.city-sightseeing.com",
  "headers": {
    "X-Webhook-Secret": "abc123"
  },
  "active": true,
  "retryOnError": true,
  "enqueuedAt": "2026-05-14T13:00:00Z",
  "createdAt": "2026-05-14T13:00:00Z",
  "updatedAt": "2026-05-14T13:00:00Z"
}

Update Subscription

patch

Path parameters

subscriptionIdstringRequired

Subscription identifier.

Example: sub_booking_update_01

Body

application/json

From capability octo/notifications.

notificationTypestringOptional

Notification type value.

Example: booking_update

notificationTypesstring[]Optional

List of notification type values.

Example: ["STANDARD"]

urlstring · uriOptional

Fully-qualified URL.

Example: https://www.city-sightseeing.com

activebooleanOptional

Whether active is enabled.

Example: true

retryOnErrorbooleanOptional

Whether retry on error is enabled.

Example: true

Responses

200

Successful response

application/json

patch

/notifications/subscriptions/{subscriptionId}

HTTPcURLJavaScriptPython

PATCH /octo/notifications/subscriptions/{subscriptionId} HTTP/1.1
Host: api.ventrata.com
Content-Type: application/json
Accept: */*
Content-Length: 185

{
  "notificationType": "booking_update",
  "notificationTypes": [
    "STANDARD"
  ],
  "url": "https://www.city-sightseeing.com",
  "headers": {
    "X-Webhook-Secret": "abc123"
  },
  "active": true,
  "retryOnError": true
}

200

Successful response

{
  "subscriptionId": "sub_booking_update_01",
  "notificationType": "booking_update",
  "notificationTypes": [
    "STANDARD"
  ],
  "url": "https://www.city-sightseeing.com",
  "headers": {
    "X-Webhook-Secret": "abc123"
  },
  "active": true,
  "retryOnError": true,
  "enqueuedAt": "2026-05-14T13:00:00Z",
  "createdAt": "2026-05-14T13:00:00Z",
  "updatedAt": "2026-05-14T13:00:00Z"
}

Response 200

Same Subscription Object shape as Create Subscription.

Get Subscription

get

Path parameters

subscriptionIdstringRequired

Subscription identifier.

Example: sub_booking_update_01

Responses

200

Successful response

application/json

get

/notifications/subscriptions/{subscriptionId}

HTTPcURLJavaScriptPython

GET /octo/notifications/subscriptions/{subscriptionId} HTTP/1.1
Host: api.ventrata.com
Accept: */*

200

Successful response

{
  "subscriptionId": "sub_booking_update_01",
  "notificationType": "booking_update",
  "notificationTypes": [
    "STANDARD"
  ],
  "url": "https://www.city-sightseeing.com",
  "headers": {
    "X-Webhook-Secret": "abc123"
  },
  "active": true,
  "retryOnError": true,
  "enqueuedAt": "2026-05-14T13:00:00Z",
  "createdAt": "2026-05-14T13:00:00Z",
  "updatedAt": "2026-05-14T13:00:00Z"
}

Response 200

Returns one Subscription Object.

List Subscriptions

get

Responses

200

Successful response

application/json

get

/notifications/subscriptions

HTTPcURLJavaScriptPython

GET /octo/notifications/subscriptions HTTP/1.1
Host: api.ventrata.com
Accept: */*

200

Successful response

[
  {
    "subscriptionId": "sub_booking_update_01",
    "notificationType": "booking_update",
    "notificationTypes": [
      "STANDARD"
    ],
    "url": "https://www.city-sightseeing.com",
    "headers": {
      "X-Webhook-Secret": "abc123"
    },
    "active": true,
    "retryOnError": true,
    "enqueuedAt": "2026-05-14T13:00:00Z",
    "createdAt": "2026-05-14T13:00:00Z",
    "updatedAt": "2026-05-14T13:00:00Z"
  }
]

Returns a paginated array of Subscription Object items.

Response 200

Array of Subscription Object.

Delete Subscription

delete

Path parameters

subscriptionIdstringRequired

Subscription identifier.

Example: sub_booking_update_01

Responses

200

Successful response

application/json

delete

/notifications/subscriptions/{subscriptionId}

HTTPcURLJavaScriptPython

DELETE /octo/notifications/subscriptions/{subscriptionId} HTTP/1.1
Host: api.ventrata.com
Accept: */*

200

Successful response

{
  "success": true,
  "message": "Deleted successfully."
}

Deletes a subscription.

Response 200

Empty body.

Triggering Notifications in Tests

Trigger Webhook

post

Path parameters

webhookIdstringRequired

Webhook identifier.

Example: webhook_booking_update

Body

application/json

From capability octo/webhooks.

productIdstringOptional

Product identifier.

Example: e7cc8bb4-8d1c-4848-8824-5dbedb718681

optionIdstringOptional

Option identifier.

Example: 94cdd032-3d32-416d-b0a4-abf8b7495b8b

availabilityIdsstring[]Optional

List of availability identifiers.

Example: ["2026-05-14T09:00:00-04:00","2026-05-15T09:00:00-04:00"]

referencestringOptional

Reference value.

Example: REF-2026-001

emailstringOptional

Email value.

Example: [email protected]

mobilestringOptional

Mobile value.

Example: [phone]

orderRecordStatestringOptional

Order record state value.

Example: order_record_state-example

productRecordStatestringOptional

Product record state value.

Example: product_record_state-example

Responses

200

Successful response

application/json

post

/webhooks/{webhookId}/trigger

HTTPcURLJavaScriptPython

POST /octo/webhooks/{webhookId}/trigger HTTP/1.1
Host: api.ventrata.com
Content-Type: application/json
Accept: */*
Content-Length: 472

{
  "productId": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
  "optionId": "94cdd032-3d32-416d-b0a4-abf8b7495b8b",
  "availabilityIds": [
    "2026-05-14T09:00:00-04:00",
    "2026-05-15T09:00:00-04:00"
  ],
  "units": [
    {
      "id": "3d6f0a3a-59d4-4b16-a0c5-11d2d8a4e6b7",
      "quantity": 2,
      "weightValue": 20,
      "weightUnit": "kg"
    }
  ],
  "reference": "REF-2026-001",
  "email": "[email protected]",
  "mobile": "[phone]",
  "orderRecordState": "order_record_state-example",
  "productRecordState": "product_record_state-example"
}

200

Successful response

{
  "status": "accepted",
  "requestId": "req_20260514_7f29b8",
  "message": "Request accepted for asynchronous processing."
}

Notification Payload Sent To Your URL

data fields by notification type:

• BOOKING_UPDATE: uuid

• AVAILABILITY_UPDATE: productId, optionId, availabilityIds

• PRODUCT_UPDATE: productId

Schema Additions (JSON)

These are additive fragments showing only fields introduced by this capability.

NotificationSubscription

{
  "// ...rest of notification subscription object": "...",
  "subscriptionId": "sub_booking_update_01",
  "url": "https://www.city-sightseeing.com",
  "notificationType": "booking_update",
  "notificationTypes": [
    "STANDARD"
  ],
  "headers": {
    "X-Webhook-Secret": "whsec_123456abcdef"
  },
  "active": true,
  "retryOnError": true,
  "enqueuedAt": "2026-05-14T13:00:00Z",
  "createdAt": "2026-05-14T13:00:00Z",
  "updatedAt": "2026-05-14T13:00:00Z"
}

NotificationSubscriptionRequest

{
  "// ...rest of notification subscription request object": "...",
  "notificationType": "booking_update",
  "url": "https://hooks.example-partner.com/octo/webhook"
}