Webhook Events (v2)

Download OpenAPI description
Languages
Servers
Mock server
https://developer.spotnana.com/_mock/openapi/webhookeventapi/
Staging URL
https://apis.spotnana.com/

webhooks

Webhooks

AGENT_TASK_DETAILSWebhook

Request

Bodyapplication/json
eventTypestring

AGENT_TASK_DETAILS

operationSummaryobject(OperationSummary)

Operation summary for webhook payload

operationstring(AgentTaskOperationType)

Agent task operation types

Enum"TASK_CREATE""TASK_UPDATE"
payloadobject(AgentTask)
timestampstring

Timestamp when the event was published

application/json
{ "eventType": "string", "operationSummary": { "ticketsIssued": [], "ticketsVoided": [], "ticketsRefunded": [] }, "operation": "TASK_CREATE", "payload": { "id": "065c77fa-900c-11ec-9eeb-0242ac170003", "primaryTraveler": {}, "travelArranger": {}, "taskType": "TAW - Tickets to print", "priority": "MEDIUM", "travelStartDate": {}, "bookingDate": {}, "status": "ACTIVE", "assignee": {}, "organization": {}, "sourcePnrId": "WIBAPI", "tripId": "065c77fa-900c-11ec-9eeb-0242ac170003", "source": "SABRE", "sourceMetadata": "5XY9", "referenceMetadata": "50", "contractingTmc": {}, "tierAtBooking": "SEAT1A", "taskOrigin": "SUPPLIER", "events": [], "assignedGroup": {}, "assignedAgent": {}, "taskDuration": {}, "pnrId": "9199471293", "assignedAgentBasicInfo": {}, "description": "Approval timed out", "createdAt": {} }, "timestamp": "string" }

Responses

OK

TRAVELER_V2Webhook

Request

Bodyapplication/json
eventTypestring

TRAVELER_V2

operationSummaryobject(OperationSummary)

Operation summary for webhook payload

operationstring(TravelerV2OperationType)

Traveler Update operation types

Enum"CREATE""UPDATE""DELETE""PURGE"
payloadobject(UserProfile)

Traveler details.

timestampstring

Timestamp when the event was published

application/json
{ "eventType": "string", "operationSummary": { "ticketsIssued": [], "ticketsVoided": [], "ticketsRefunded": [] }, "operation": "DELETE", "payload": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "personalInfo": {}, "businessInfo": {}, "persona": "EMPLOYEE", "isActive": true, "tier": "SEAT1A", "relativeOf": {}, "travelPreferences": {}, "membershipInfo": {}, "notificationPreferences": {}, "travelArrangers": {}, "adhocUserInfo": {}, "externalId": "string" }, "timestamp": "string" }

Responses

OK

PNR_APPROVALWebhook

Request

Bodyapplication/json
eventTypestring

PNR_APPROVAL

operationSummaryobject(OperationSummary)

Operation summary for webhook payload

operationstring(ApprovalType)

Type of APPROVAL

Enum"HARD_APPROVAL""SOFT_APPROVAL""PASSIVE_APPROVAL"
payloadobject(PnrApprovalEventPayload)
timestampstring

Timestamp when the event was published

application/json
{ "eventType": "string", "operationSummary": { "ticketsIssued": [], "ticketsVoided": [], "ticketsRefunded": [] }, "operation": "SOFT_APPROVAL", "payload": { "pnrId": "string", "tripId": "string", "approvalId": "string", "appliedApprovalType": "SOFT_APPROVAL", "deadline": {}, "approvers": [] }, "timestamp": "string" }

Responses

OK

SERVICE_CHARGEWebhook

Request

Bodyapplication/json
eventTypestring

SERVICE_CHARGE

operationSummaryobject(OperationSummary)

Operation summary for webhook payload

operationstring(ServiceChargeOperationType)

Service charge operation types

Value"SERVICE_FEE"
payloadobject(ServiceChargeRecord)

Service charge record.

timestampstring

Timestamp when the event was published

application/json
{ "eventType": "string", "operationSummary": { "ticketsIssued": [], "ticketsVoided": [], "ticketsRefunded": [] }, "operation": "SERVICE_FEE", "payload": { "entity": {}, "tripId": "1234567890", "serviceChargeType": "TMC_CHARGE", "serviceType": "ITINERARY_BOOKING", "agentContact": {}, "charge": {}, "transactionTime": {}, "paymentStatus": "SUCCESS", "userOrgId": {}, "bookingDetails": {}, "fop": {}, "paymentTransaction": {}, "failureDetails": {} }, "timestamp": "string" }

Responses

OK

PNR_V3Webhook

Request

Bodyapplication/json
eventTypestring

PNR_V3

operationSummaryobject(OperationSummary)

Operation summary for webhook payload

operationstring(PnrTripDetailOperationType)

Pnr and trip details operation types

Enum"BOOKING_CREATED""BOOKING_OTHER_UPDATE""TRIP_UPDATED""BOOKING_UPDATED""BOOKING_CANCELED_BY_TRAVELER""BOOKING_CANCELED_BY_VENDOR""BOOKING_REBOOKED""BOOKING_TICKETED""TICKET_VOIDED""TICKET_REFUNDED"
payloadobject(PnrData)

Pnr data with all information about a single booking containing one of Air, Hotel, Car, Rail, Limo or Miscellaneous PNR.

timestampstring

Timestamp when the event was published

application/json
{ "eventType": "string", "operationSummary": { "ticketsIssued": [], "ticketsVoided": [], "ticketsRefunded": [] }, "operation": "BOOKING_CREATED", "payload": { "version": 1, "createdVia": "OFFLINE", "initialVersionCreatedVia": "OFFLINE", "sourceInfo": {}, "invoiceDelayedBooking": false, "travelers": [], "pnrTravelers": [], "costOfGoodsSold": {}, "costToCustomer": {}, "transactions": [], "isFinalized": false, "policyInfo": {}, "airPnr": {}, "hotelPnr": {}, "carPnr": {}, "railPnr": {}, "limoPnr": {}, "miscPnr": {}, "additionalMetadata": {}, "preBookAnswers": {}, "customFields": [], "bookingHistory": [], "totalFare": {}, "serviceFees": [], "paymentInfo": [], "bookingStatus": "PENDING_STATUS", "contactSupport": false, "travelerPnrVisibilityStatus": "VISIBLE", "shellPnrInfo": {}, "pnrCreationDetails": {}, "approvalInfo": [], "cancellationRequestStatus": "CANCELLATION_IN_PROGRESS", "externalInfo": {}, "tripId": "123456789", "documents": [], "freshnessInfo": {}, "bookingEmailInfo": {}, "llfPnrInfo": {}, "pnrId": "123456789", "invoiceInfos": [], "totalFareAmount": {}, "dkNumber": "123456789", "savingsFare": {}, "tripUsageMetadata": {} }, "timestamp": "string" }

Responses

OK

TRIP_DETAILS_V3Webhook

Request

Bodyapplication/json
eventTypestring

TRIP_DETAILS_V3

operationSummaryobject(OperationSummary)

Operation summary for webhook payload

operationstring(PnrTripDetailOperationType)

Pnr and trip details operation types

Enum"BOOKING_CREATED""BOOKING_OTHER_UPDATE""TRIP_UPDATED""BOOKING_UPDATED""BOOKING_CANCELED_BY_TRAVELER""BOOKING_CANCELED_BY_VENDOR""BOOKING_REBOOKED""BOOKING_TICKETED""TICKET_VOIDED""TICKET_REFUNDED"
payloadobject(TripV3DetailsResponse)

Trip Details Response for a given trip Id

timestampstring

Timestamp when the event was published

application/json
{ "eventType": "string", "operationSummary": { "ticketsIssued": [], "ticketsVoided": [], "ticketsRefunded": [] }, "operation": "BOOKING_CREATED", "payload": { "basicTripInfo": {}, "pnrs": [], "pendingShellPnrs": [], "pendingManualFormPnrs": [], "tripStatus": "CONFIRMED", "tripBookingStatus": "PENDING_STATUS", "eventSummary": {}, "simplePnrs": [], "additionalInfo": {}, "tripPaymentInfo": {} }, "timestamp": "string" }

Responses

OK