Add Ticket Webhook
When a broker creates a listing from within Tixstock and publishes it to the resellers exchange, an add ticket webhook request will be sent to the reseller to notify them of the listing to be created.
It is required that the resellers creates the listing and sets the status as published.
Post Data
The listing resource will be sent to the reseller including all information regarding the listing to be created.
As the listing isn't yet published, the listing ID will be sent as NULL
, and the published status will be set to false
. The display price returned in the resource is Tixstock's estimation for the display price based from the proceed price set, which is converted into the resellers event currency with any relevant reseller exchange fees included.
The reseller is required to return whether the listing has been created successfully, providing the listing ID and the correct display price for the listing. Tixstock will then update the listing to save the display price returned and set the listing status to published.
Example Request
{
"data": {
"id": null,
"broker_id": "123123",
"ticket": {
"general_admission": "false",
"type": "Paper",
"allow_last_minute_sales": "false",
"split_type": "All Together",
"eticket": [],
"upload_later": "false"
},
"number_of_tickets_for_sale": {
"quantity_available": 3,
"quantity_sold": 0,
"display_quantity": 1,
"split_quantity": 0
},
"seat_details": {
"category": "Stalls",
"section": "Stalls",
"row": "B",
"first_seat": "11"
},
"face_value": {
"currency": "GBP",
"amount": "100.00"
},
"display_price": {
"currency": "GBP",
"amount": "165.00"
},
"proceed_price": {
"currency": "GBP",
"amount": "150.00"
},
"restrictions_benefits": {
"options": [
"Behind stage (printed on ticket)"
],
"other": "Other Restriction"
},
"delivery": {
"type": "UPS",
"hand_delivered": "true",
"ready_shipped": "true",
"shipped_date_or_date_in_hand": "2020-03-10"
},
"event": {
"id": "9123123",
"name": "Jimmy Carr Dorking",
"currency": "GBP",
"commission_percentage_fee": "10.00",
"description": "Jimmy Carr Dorking",
"datetime": "2020-06-27T13:46:40+0000",
"status": "Active",
"venue": {
"name": "Dorking Halls",
"address_line_1": "",
"address_line_2": "",
"city": "Dorking",
"state": "SRY",
"postcode": "RH4 1SG",
"country_code": "GB"
},
"use_tixstock_venue_details": "true",
"venue_details": [],
"performers": [
{
"id": "10040",
"name": "Jimmy Carr"
}
]
},
"published_date": "",
"proof_of_purchase": "",
"published": "false"
},
"meta": {
"type": "ticket.create"
}
}
Resellers JSON Response
It is required that resellers provide a valid JSON response back from the webhook request.
It is required that the reseller provide back the listing ID and the display price amount for the listing.
Success Response
Resellers should only provide the successful response if listing has been created and is published on their reseller website.
{
"listing_id": "92312212",
"display_price": "180.00",
"success": true,
"message": "Ticket successfully added."
}
On success, the display price will be stored against the listing, using the resellers event currency for the display price currency. The listing published status will be set to
true
and the supplied listing ID will be stored against the resellers listing.
Error Response
{
"listing_id": null,
"success": false,
"message": "Ticket failed to be created.",
"errors": [
"Error message here"
]
}
On error, the listings publish status will remain as
false