Webhook tests

A collection of endpoints to test webhooks in PORTA's sandbox environment.

Test hold availability

Send a hold availability request in the sandbox environment to test your integration. The response will be the response from your webhook service.

SecuritySupplier-sandbox
Request
header Parameters
accept
required
string

Specify the format of the response.

Value: "application/json"
accept-version
required
string (PORTA version)

The version of PORTA for the request.

Value: Description
vnd.porta-api.v1

Version 1.0.0

Request Body schema: application/json
experience_id
required
string^(?!\-|\.|\_)[0-9a-z\-\.\_]{1,50}$

The ID for an existing sandbox experience.

expiration_time
required
string <date-time>

When the hold availability request can expire, based on the agreed upon hold_duration value.

The value for this property must be in the local time for the experience with no time zone information, following the ISO 8601 standard.

hold_id
required
string <uuid>

A randomly-generated UUID. The same hold_id value must be used when testing the booking confirmation webhook.

option_id
required
string^(?!\-|\.|\_)[0-9a-z\-\.\_]{1,50}$

The ID for an existing sandbox option.

pickup_id
string^(?!\-|\.|\_)[0-9a-z\-\.\_]{1,50}$

The ID for an existing sandbox pickup, if any.

required
Array of objects unique

An array of the requested holder categories and their quantities.

slot_id
required
string^(?!\-|\.|\_)[0-9a-z\-\.\_]{1,50}$

The ID for an existing sandbox availability slot.

Responses
200

Test hold availability request accepted

default

Error response

post/supplier/integration-tests/hold
Request samples
application/json
{
  • "experience_id": "string",
  • "expiration_time": "2024-04-22T12:42:37+0000",
  • "hold_id": "4ce991bb-2101-434c-985c-39697d3f31c4",
  • "option_id": "string",
  • "pickup_id": "string",
  • "quantities": [
    ],
  • "slot_id": "string"
}
Response samples
application/json
{
  • "code": "400",
  • "id": "3ecae132-a32d-41f9-8f7d-586f34cc29ce",
  • "message": "Check the request for errors."
}

Test booking confirmation

Send a booking confirmation request in the sandbox environment to test your integration. This request format differs from what is eventually sent to the webhook service. The final request will also contain a randomly-generated tuimm_booking_id property.

The response will be the response from your webhook service.

SecuritySupplier-sandbox
Request
header Parameters
accept
required
string

Specify the format of the response.

Value: "application/json"
accept-version
required
string (PORTA version)

The version of PORTA for the request.

Value: Description
vnd.porta-api.v1

Version 1.0.0

Request Body schema: application/json
booking_id
required
string <uuid>

A randomly-generated UUID. The same booking_id value must be used when testing the booking cancellation webhook.

required
Array of objects unique

An array of items for the booking.

hold_id
required
string

The ID of the sandbox hold availability request.

required
object

Randomly-generated lead booker information.

pickup_id
string^(?!\-|\.|\_)[0-9a-z\-\.\_]{1,50}$

The ID of an existing sandbox pickup, if any.

Note that the location of this property differs from its location in the confirmation request sent to your webhook service.

slot_id
required
string^(?!\-|\.|\_)[0-9a-z\-\.\_]{1,50}$

The ID of an existing sandbox availability slot.

Note that the location of this property differs from its location in the confirmation request sent to your webhook service.

request_id
required
string <uuid>

In production this property reflects PORTA's own ID for the item in the webhook request. Here, it can be a randomly-generated UUID. The same request_id value will appear in the request sent to the webhook service.

Note that the location of this property differs from its location in the confirmation request sent to your webhook service.

Responses
200

Test booking confirmation request accepted

default

Error response

post/supplier/integration-tests/book
Request samples
application/json
{
  • "booking_id": "b0ae0641-0cd4-4f7f-8550-dcd550941f4a",
  • "booking_requests": [
    ],
  • "hold_id": "string",
  • "holder": {
    },
  • "pickup_id": "string",
  • "slot_id": "string",
  • "request_id": "266ea41d-adf5-480b-af50-15b940c2b846"
}
Response samples
application/json
{
  • "code": "400",
  • "id": "3ecae132-a32d-41f9-8f7d-586f34cc29ce",
  • "message": "Check the request for errors."
}

Test booking cancellation

Send a booking cancellation request in the sandbox environment to test your integration. The response will be the response from your webhook service.

SecuritySupplier-sandbox
Request
header Parameters
accept
required
string

Specify the format of the response.

Value: "application/json"
accept-version
required
string (PORTA version)

The version of PORTA for the request.

Value: Description
vnd.porta-api.v1

Version 1.0.0

Request Body schema: application/json
One of:
booking_id
required
string <uuid>

The ID of the booking to cancel.

ticket_numbers
required
Array of strings

A list of ticket values issued by the original booking confirmation response.

transaction_id
required
string

The ID issued by the original booking confirmation response.

Responses
200

Booking cancellation request accepted

default

Error response

post/supplier/integration-tests/cancel-booking
Request samples
application/json
{
  • "booking_id": "b0ae0641-0cd4-4f7f-8550-dcd550941f4a",
  • "ticket_numbers": [
    ],
  • "transaction_id": "string"
}
Response samples
application/json
{
  • "code": "400",
  • "id": "3ecae132-a32d-41f9-8f7d-586f34cc29ce",
  • "message": "Check the request for errors."
}
Copyright © TUI Musement. All rights reserved.