Developer portal

Types

List of all webhooks types

Scheduled E-tickets Available

Sent when tickets with delivery type Scheduled E-tickets become available.

Details

Trigger

Triggered when scheduled date for scheduled e-tickets is in the past (see TicketInfoBooking and ScheduledOn field for reference)

Scope

Sent for every basket individually

Authentication

Please see Webhook Authentication for details

Payload

Name Data type Additional information
AffiliateId Guid Your unique partner identifier
BookingReference string Booking reference that this webhook was sent for
CustomerEmail string Email of the customer that placed the booking
Tickets Collection of AvailableScheduledEticketInfo Contains information about the tickets 
{
    "MessageType":"ScheduledEticketDelivery",
    "Payload":{
        "AffiliateId": "281ffaaa-a70b-4cd2-a401-9e50b00a1204",
        "BookingReference": "ABC01599",
        "CustomerEmail": "[email protected]",
        "Tickets": [
            {
                "EventName": "Christmas Actually",
                "PerformanceDate": "2023-12-07T19:30:00",
                "TicketName1": "N",
                "TicketName2": 40,
                "AreaName": "Balcony",
                "VenueName": "Royal Festival Hall, Southbank Centre",
                "Barcode": "00000015125182882200",
                "BarcodeType": "QRCode"
            },
            {
                "EventName": "Christmas Actually",
                "PerformanceDate": "2023-12-07T19:30:00",
                "TicketName1": "N",
                "TicketName2": 39,
                "AreaName": "Balcony",
                "VenueName": "Royal Festival Hall, Southbank Centre",
                "Barcode": "00000015125182882200",
                "BarcodeType": "QRCode"
            },
            {
                "EventName": "Christmas Actually",
                "PerformanceDate": "2023-12-07T19:30:00",
                "TicketName1": "N",
                "TicketName2": 38,
                "AreaName": "Balcony",
                "VenueName": "Royal Festival Hall, Southbank Centre",
                "Barcode": "00000015125182882200",
                "BarcodeType": "QRCode"
            }
    ]},
  "Timestamp": "2024-03-05T08:26:11.1451352Z"
}

Transaction changed

Sent when transaction is changed or created. Can be used to react to ticket cancellations, change of delivery informations or to other changes on transaction.

Details

Trigger

Triggered when transaction is changed or created.

Scope

Sent for every transaction individually

Authentication

Please see Webhook Authentication for details

Payload

Name Data type Additional information
BookingReference string Booking reference that this webhook was sent for
BasketId Guid Basket ID
DeliveryType enum Enum type of DeliveryType
TotalAmount decimal Total booking price
TotalCount int Number of tickets
Customer Type of Customer Contains information about the customer
PurchaseDateTime DateTime Date and time of purchase
Orders Collection of OrderTicketResponse Contains information about the tickets 
{
    "MessageType": "TransactionChanged",
    "Payload": {
        "BookingReference": "CSK46133",
        "BasketId": "33de23ee-5e42-4aba-b941-6546e57fec28",
        "DeliveryType": "Print at Home",
        "TotalAmount": 108,
        "TotalCount": 1,
        "Customer": {
            "FullName": "Morgan Better",
            "Email": "[email protected]",
            "PhoneNumber": "1234657",
            "Address": {
                "AddressLine1": "",
                "AddressLine2": "",
                "AddressLine3": null,
                "AddressLine4": null,
                "City": "",
                "Country": "GB",
                "PostCode": ""
            }
        },
        "PurchaseDateTime": "2023-11-09T09:47:59.623",
        "Orders": [
            {
                "EventId": 3868,
                "EventImageUrl": "https://media.londontheatredirect.com/Event/FrozenTheMusical/event-detail-image_36364.jpg",
                "PerformanceTimeDate": "2024-03-17T13:00:00",
                "VenueName": "Theatre Royal Drury Lane",
                "VenueId": 11,
                "EventName": "Frozen The Musical",
                "Tickets": [
                    {
                        "SeatInfo": "E15",
                        "Barcode": "23017425",
                        "BarcodeType": "QRCode",
                        "Status": "Purchased"
                    },
                    {
                        "SeatInfo": "J7",
                        "Barcode": "23017426",
                        "BarcodeType": "QRCode",
                        "Status": "Cancelled"
                    }
                ],
                "OrderStatus": "Cancelled"
            }
        ]
    },
    "Timestamp": "2024-03-05T08:26:11.1451352Z"
}