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

From capability octo/notifications.

notificationTypesstring[]Optional

List of notification type values.

Example: ["STANDARD"]

urlstring · uriOptional

Fully-qualified URL.

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

retryOnErrorbooleanOptional

Whether retry on error is enabled.

Example: true

Responses

200

Successful response

application/json

From capability octo/notifications.

subscriptionIdstringRequired

Subscription identifier.

Example: sub_booking_update_01

notificationTypesstring[]Optional

List of notification type values.

Example: ["STANDARD"]

urlstring · uriRequired

Fully-qualified URL.

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

retryOnErrorbooleanOptional

Whether retry on error is enabled.

Example: true

post/notifications/subscriptions

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

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

200

Successful response

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

Update Subscription

patch

Path parameters

subscriptionIdstringRequired

Subscription identifier.

Example: sub_booking_update_01

Body

From capability octo/notifications.

notificationTypesstring[]Optional

List of notification type values.

Example: ["STANDARD"]

urlstring · uriOptional

Fully-qualified URL.

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

retryOnErrorbooleanOptional

Whether retry on error is enabled.

Example: true

Responses

200

Successful response

application/json

From capability octo/notifications.

subscriptionIdstringRequired

Subscription identifier.

Example: sub_booking_update_01

notificationTypesstring[]Optional

List of notification type values.

Example: ["STANDARD"]

urlstring · uriRequired

Fully-qualified URL.

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

retryOnErrorbooleanOptional

Whether retry on error is enabled.

Example: true

patch/notifications/subscriptions/{subscriptionId}

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

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

200

Successful response

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

Get Subscription

get

Path parameters

subscriptionIdstringRequired

Subscription identifier.

Example: sub_booking_update_01

Responses

200

Successful response

application/json

From capability octo/notifications.

subscriptionIdstringRequired

Subscription identifier.

Example: sub_booking_update_01

notificationTypesstring[]Optional

List of notification type values.

Example: ["STANDARD"]

urlstring · uriRequired

Fully-qualified URL.

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

retryOnErrorbooleanOptional

Whether retry on error is enabled.

Example: true

get/notifications/subscriptions/{subscriptionId}

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

200

Successful response

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

List Subscriptions

get

Responses

200

Successful response

application/json

From capability octo/notifications.

subscriptionIdstringRequired

Subscription identifier.

Example: sub_booking_update_01

notificationTypesstring[]Optional

List of notification type values.

Example: ["STANDARD"]

urlstring · uriRequired

Fully-qualified URL.

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

retryOnErrorbooleanOptional

Whether retry on error is enabled.

Example: true

get/notifications/subscriptions

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

200

Successful response

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

Returns a paginated array of Subscription Object items.

Delete Subscription

delete

Path parameters

subscriptionIdstringRequired

Subscription identifier.

Example: sub_booking_update_01

Responses

200

Successful response

application/json

successbooleanRequired

Whether success is enabled.

Example: true

messagestringOptional

Message value.

Example: Deleted successfully.

delete/notifications/subscriptions/{subscriptionId}

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

200

Successful response

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

Deletes a subscription.

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",
  "notificationTypes": [
    "STANDARD"
  ],
  "headers": {
    "X-Webhook-Secret": "whsec_123456abcdef"
  },
  "retryOnError": true
}

NotificationSubscriptionRequest

{
  "// ...rest of notification subscription request object": "...",
  "notificationTypes": [
    "BOOKING_UPDATE"
  ],
  "url": "https://hooks.example-partner.com/octo/webhook"
}