viagogo Webhooks API (2.249.0.0)
When configuring a webhook, you can choose the topics you would like to receive payloads for. You should only subscribe to the specific topics that you plan on handling so that you can limit the number of HTTP requests to your server.
Sales Webhook
Triggered when something happens that affects a sale (e.g. you sell one or more tickets).
Authorizations:
read:webhooks
write:webhooks
) Request Body schema: application/json
Array of objects or null (BarcodeInformation) The barcodes that are linked to the sale. | |
topic | string or null The topic of the webhook. |
action | string or null The action that triggered this webhook. |
(SalesTopicLinks (object or null)) | |
(SalesTopicEmbeddedResources (object or null)) |
Responses
Request samples
- Payload
{- "barcodes": [
- {
- "seat_ordinal": 0,
- "seat": "string",
- "row": "string",
- "status": "string",
- "barcode_values": [
- "string"
]
}
], - "topic": "string",
- "action": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "event": {
- "id": 0,
- "name": "string",
- "start_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z",
- "on_sale_date": "2019-08-24T14:15:22Z",
- "date_confirmed": true,
- "merged_events": [
- {
- "id": 0
}
], - "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}, - "sale": {
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "seating": {
- "section": "string",
- "row": "string",
- "seat_from": "string",
- "seat_to": "string"
}, - "proceeds": {
- "amount": 0,
- "currency_code": "string",
- "display": "string"
}, - "number_of_tickets": 0,
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}, - "seller_listing": {
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "number_of_tickets": 0,
- "seating": {
- "section": "string",
- "row": "string",
- "seat_from": "string",
- "seat_to": "string",
- "state": {
- "visible_in_venue_map": true
}
}, - "display_seating": {
- "section": "string",
- "row": "string",
- "seat_from": "string",
- "seat_to": "string",
- "state": {
- "visible_in_venue_map": true
}
}, - "ticket_price": {
- "amount": 0,
- "currency_code": "string",
- "display": "string"
}, - "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}, - "venue": {
- "id": 0,
- "name": "string",
- "city": "string",
- "state_province": "string",
- "latitude": 0,
- "longitude": 0,
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "country": {
- "code": "string",
- "name": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "country:events": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "country:localwebpage": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}
}
}, - "webhook": {
- "id": 0,
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "topics": [
- "string"
], - "url": "string",
- "authorization_header": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "webhook:delete": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "webhook:ping": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "webhook:update": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}
}
}
ProvisionalSale Webhook
Triggered when a provisional sale occurs. The normal SalesTopic
webhook will confirm the provisional sale. If you want to reject the provisional sale, ignore it and reject the sale when it comes through as normal.
Authorizations:
read:webhooks
write:webhooks
) Request Body schema: application/json
Array of objects or null (BarcodeInformation) The barcodes that are linked to the sale. | |
topic | string or null The topic of the webhook. |
action | string or null The action that triggered this webhook. |
(ProvisionalSaleTopicLinks (object or null)) | |
(ProvisionalSaleTopicEmbeddedResources (object or null)) |
Responses
Request samples
- Payload
{- "barcodes": [
- {
- "seat_ordinal": 0,
- "seat": "string",
- "row": "string",
- "status": "string",
- "barcode_values": [
- "string"
]
}
], - "topic": "string",
- "action": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "event": {
- "id": 0,
- "name": "string",
- "start_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z",
- "on_sale_date": "2019-08-24T14:15:22Z",
- "date_confirmed": true,
- "merged_events": [
- {
- "id": 0
}
], - "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}, - "sale": {
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "seating": {
- "section": "string",
- "row": "string",
- "seat_from": "string",
- "seat_to": "string"
}, - "proceeds": {
- "amount": 0,
- "currency_code": "string",
- "display": "string"
}, - "number_of_tickets": 0,
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}, - "seller_listing": {
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "number_of_tickets": 0,
- "seating": {
- "section": "string",
- "row": "string",
- "seat_from": "string",
- "seat_to": "string",
- "state": {
- "visible_in_venue_map": true
}
}, - "display_seating": {
- "section": "string",
- "row": "string",
- "seat_from": "string",
- "seat_to": "string",
- "state": {
- "visible_in_venue_map": true
}
}, - "ticket_price": {
- "amount": 0,
- "currency_code": "string",
- "display": "string"
}, - "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}, - "venue": {
- "id": 0,
- "name": "string",
- "city": "string",
- "state_province": "string",
- "latitude": 0,
- "longitude": 0,
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "country": {
- "code": "string",
- "name": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "country:events": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "country:localwebpage": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}
}
}, - "webhook": {
- "id": 0,
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "topics": [
- "string"
], - "url": "string",
- "authorization_header": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "webhook:delete": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "webhook:ping": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "webhook:update": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}
}
}
CancelProvisionalSale Webhook
Triggered when a provisional sale is cancelled.
Authorizations:
read:webhooks
write:webhooks
) Request Body schema: application/json
Array of objects or null (BarcodeInformation) The barcodes that are linked to the sale. | |
topic | string or null The topic of the webhook. |
action | string or null The action that triggered this webhook. |
(CancelProvisionalSaleTopicLinks (object or null)) | |
(CancelProvisionalSaleTopicEmbeddedResources (object or null)) |
Responses
Request samples
- Payload
{- "barcodes": [
- {
- "seat_ordinal": 0,
- "seat": "string",
- "row": "string",
- "status": "string",
- "barcode_values": [
- "string"
]
}
], - "topic": "string",
- "action": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "event": {
- "id": 0,
- "name": "string",
- "start_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z",
- "on_sale_date": "2019-08-24T14:15:22Z",
- "date_confirmed": true,
- "merged_events": [
- {
- "id": 0
}
], - "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}, - "sale": {
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "seating": {
- "section": "string",
- "row": "string",
- "seat_from": "string",
- "seat_to": "string"
}, - "proceeds": {
- "amount": 0,
- "currency_code": "string",
- "display": "string"
}, - "number_of_tickets": 0,
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}, - "seller_listing": {
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "number_of_tickets": 0,
- "seating": {
- "section": "string",
- "row": "string",
- "seat_from": "string",
- "seat_to": "string",
- "state": {
- "visible_in_venue_map": true
}
}, - "display_seating": {
- "section": "string",
- "row": "string",
- "seat_from": "string",
- "seat_to": "string",
- "state": {
- "visible_in_venue_map": true
}
}, - "ticket_price": {
- "amount": 0,
- "currency_code": "string",
- "display": "string"
}, - "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}, - "venue": {
- "id": 0,
- "name": "string",
- "city": "string",
- "state_province": "string",
- "latitude": 0,
- "longitude": 0,
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "country": {
- "code": "string",
- "name": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "country:events": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "country:localwebpage": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}
}
}, - "webhook": {
- "id": 0,
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "topics": [
- "string"
], - "url": "string",
- "authorization_header": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "webhook:delete": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "webhook:ping": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "webhook:update": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}
}
}
SaleUpdates Webhook
Triggered when an update is made to a sale that you did not initiate. You will need to filter by the action that you are interested in. The currently support action is FailedBarcodeValidation
which will tell you if validation of a set of barcodes uploaded against an order has failed, and barcodes need re-uploading.
Authorizations:
read:webhooks
write:webhooks
) Request Body schema: application/json
Array of objects or null (BarcodeInformation) The barcodes that are linked to the sale. | |
topic | string or null The topic of the webhook. |
action | string or null The action that trigger this webhook. Can be |
(SaleUpdatesTopicLinks (object or null)) | |
(SaleUpdatesTopicEmbeddedResources (object or null)) |
Responses
Request samples
- Payload
{- "barcodes": [
- {
- "seat_ordinal": 0,
- "seat": "string",
- "row": "string",
- "status": "string",
- "barcode_values": [
- "string"
]
}
], - "topic": "string",
- "action": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "event": {
- "id": 0,
- "name": "string",
- "start_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z",
- "on_sale_date": "2019-08-24T14:15:22Z",
- "date_confirmed": true,
- "merged_events": [
- {
- "id": 0
}
], - "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}, - "sale": {
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "seating": {
- "section": "string",
- "row": "string",
- "seat_from": "string",
- "seat_to": "string"
}, - "proceeds": {
- "amount": 0,
- "currency_code": "string",
- "display": "string"
}, - "number_of_tickets": 0,
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}, - "seller_listing": {
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "number_of_tickets": 0,
- "seating": {
- "section": "string",
- "row": "string",
- "seat_from": "string",
- "seat_to": "string",
- "state": {
- "visible_in_venue_map": true
}
}, - "display_seating": {
- "section": "string",
- "row": "string",
- "seat_from": "string",
- "seat_to": "string",
- "state": {
- "visible_in_venue_map": true
}
}, - "ticket_price": {
- "amount": 0,
- "currency_code": "string",
- "display": "string"
}, - "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}, - "venue": {
- "id": 0,
- "name": "string",
- "city": "string",
- "state_province": "string",
- "latitude": 0,
- "longitude": 0,
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "country": {
- "code": "string",
- "name": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "country:events": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "country:localwebpage": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}
}
}, - "webhook": {
- "id": 0,
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "topics": [
- "string"
], - "url": "string",
- "authorization_header": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "webhook:delete": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "webhook:ping": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "webhook:update": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}
}
}
SellerListingUpdates Webhook
Triggered when an update is made to a listing that you did not initiate. You will need to filter by the action that you are interested in. The currently support actions are FailedBarcodeValidation
and ListingDeliverabilityExpired
. FailedBarcodeValidation
will tell you if validation of a set of barcodes uploaded against a listing has failed, and barcodes need re-uploading. ListingDeliverabilityExpired
will tell you that a listing is not longer deliverable to a customer. To increase the deliverability of electronic type tickets, preupload them (e.g. pre-upload barcodes or PDF files.) To increase deliverability of paper tickets, opt your tickets into our LMS program.
Authorizations:
read:webhooks
write:webhooks
) Request Body schema: application/json
topic | string or null The topic of the webhook. |
action | string or null The action that trigger this webhook. Can be |
Array of objects or null (BarcodeInformation2) The barcodes that are linked to the listing. | |
(SellerListingUpdatesTopicLinks (object or null)) | |
(SellerListingUpdatesTopicEmbeddedResources (object or null)) |
Responses
Request samples
- Payload
{- "topic": "string",
- "action": "string",
- "barcodes": [
- {
- "seat_ordinal": 0,
- "seat": "string",
- "row": "string",
- "status": "string",
- "barcode_values_sha256_hashed": [
- "string"
]
}
], - "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "event": {
- "id": 0,
- "name": "string",
- "start_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z",
- "on_sale_date": "2019-08-24T14:15:22Z",
- "date_confirmed": true,
- "merged_events": [
- {
- "id": 0
}
], - "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}, - "seller_listing": {
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "number_of_tickets": 0,
- "seating": {
- "section": "string",
- "row": "string",
- "seat_from": "string",
- "seat_to": "string",
- "state": {
- "visible_in_venue_map": true
}
}, - "display_seating": {
- "section": "string",
- "row": "string",
- "seat_from": "string",
- "seat_to": "string",
- "state": {
- "visible_in_venue_map": true
}
}, - "ticket_price": {
- "amount": 0,
- "currency_code": "string",
- "display": "string"
}, - "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}, - "venue": {
- "id": 0,
- "name": "string",
- "city": "string",
- "state_province": "string",
- "latitude": 0,
- "longitude": 0,
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "country": {
- "code": "string",
- "name": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "country:events": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "country:localwebpage": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}
}
}, - "webhook": {
- "id": 0,
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "topics": [
- "string"
], - "url": "string",
- "authorization_header": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "webhook:delete": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "webhook:ping": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "webhook:update": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}
}
}
Ping Webhook
Triggered any time a Webhook is pinged.
Authorizations:
read:webhooks
write:webhooks
) Request Body schema: application/json
topic | string or null The topic of the webhook. |
action | string or null The action that triggered this webhook. |
(PingTopicLinks (object or null)) | |
(PingTopicEmbeddedResources (object or null)) |
Responses
Request samples
- Payload
{- "topic": "string",
- "action": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "webhook": {
- "id": 0,
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "topics": [
- "string"
], - "url": "string",
- "authorization_header": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "webhook:delete": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "webhook:ping": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "webhook:update": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}
}
}
ReTransferTicket Webhook
Triggered when a ticket was not received by the buyer, so the ticket must be re-transferred from the 3rd party provider.
Authorizations:
read:webhooks
write:webhooks
) Request Body schema: application/json
Array of objects or null (BarcodeInformation) The barcodes that are linked to the sale. | |
topic | string or null The topic of the webhook. |
action | string or null The action that triggered this webhook. |
(ReTransferTicketTopicLinks (object or null)) | |
(ReTransferTicketTopicEmbeddedResources (object or null)) |
Responses
Request samples
- Payload
{- "barcodes": [
- {
- "seat_ordinal": 0,
- "seat": "string",
- "row": "string",
- "status": "string",
- "barcode_values": [
- "string"
]
}
], - "topic": "string",
- "action": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "event": {
- "id": 0,
- "name": "string",
- "start_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z",
- "on_sale_date": "2019-08-24T14:15:22Z",
- "date_confirmed": true,
- "merged_events": [
- {
- "id": 0
}
], - "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}, - "sale": {
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "seating": {
- "section": "string",
- "row": "string",
- "seat_from": "string",
- "seat_to": "string"
}, - "proceeds": {
- "amount": 0,
- "currency_code": "string",
- "display": "string"
}, - "number_of_tickets": 0,
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}, - "seller_listing": {
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "number_of_tickets": 0,
- "seating": {
- "section": "string",
- "row": "string",
- "seat_from": "string",
- "seat_to": "string",
- "state": {
- "visible_in_venue_map": true
}
}, - "display_seating": {
- "section": "string",
- "row": "string",
- "seat_from": "string",
- "seat_to": "string",
- "state": {
- "visible_in_venue_map": true
}
}, - "ticket_price": {
- "amount": 0,
- "currency_code": "string",
- "display": "string"
}, - "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}, - "venue": {
- "id": 0,
- "name": "string",
- "city": "string",
- "state_province": "string",
- "latitude": 0,
- "longitude": 0,
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "country": {
- "code": "string",
- "name": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "country:events": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "country:localwebpage": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}
}
}, - "webhook": {
- "id": 0,
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "topics": [
- "string"
], - "url": "string",
- "authorization_header": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "webhook:delete": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "webhook:ping": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "webhook:update": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}
}
}
List webhooks
List webhooks for the authenticated user.
Authorizations:
read:webhooks
) query Parameters
page | integer <int32> Specifies which page of data to retrieve. |
page_size | integer <int32> Set custom page sizes on response. |
sort | string Determines the ordering of items. A comma-separated string containing |
Responses
Response Schema: application/hal+json
total_items | integer or null <int32> |
page | integer or null <int32> |
page_size | integer or null <int32> |
(WebhooksLinks (object or null)) | |
(WebhooksEmbeddedResources (object or null)) |
Response samples
- 200
- 401
- 403
- 404
- 500
{- "total_items": 0,
- "page": 0,
- "page_size": 0,
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "first": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "last": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "next": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "prev": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "items": [
- {
- "id": 0,
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "topics": [
- "string"
], - "url": "string",
- "authorization_header": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "webhook:delete": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "webhook:ping": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "webhook:update": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}
]
}
}
Create a webhook
Authorizations:
write:webhooks
) Request Body schema: application/json
name | string or null The name of the webhook. |
url | string or null The server endpoint that will receive the webhook payload. |
authorization_header | string or null The Authorization header value that should be included in requests to the webhook. |
topics | Array of strings or null An array of the topics the webhook is trigger for. |
Responses
Response Schema: application/hal+json
id | integer or null <int32> The webhook identifier. |
name | string or null The name of the webhook. |
created_at | string <date-time> The date when the webhook was created. |
topics | Array of strings or null An array of the topics the webhook is trigger for. |
url | string or null The server endpoint that will receive the webhook payload. |
authorization_header | string or null The Authorization header value that should be included in requests to the webhook. |
(WebhookLinks (object or null)) |
Request samples
- Payload
{- "name": "string",
- "url": "string",
- "authorization_header": "string",
- "topics": [
- "string"
]
}
Response samples
- 201
- 400
- 401
- 403
- 500
{- "id": 0,
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "topics": [
- "string"
], - "url": "string",
- "authorization_header": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "webhook:delete": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "webhook:ping": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "webhook:update": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}
Get a webhook
Authorizations:
read:webhooks
) path Parameters
webhookId required | integer <int32> |
Responses
Response Schema: application/hal+json
id | integer or null <int32> The webhook identifier. |
name | string or null The name of the webhook. |
created_at | string <date-time> The date when the webhook was created. |
topics | Array of strings or null An array of the topics the webhook is trigger for. |
url | string or null The server endpoint that will receive the webhook payload. |
authorization_header | string or null The Authorization header value that should be included in requests to the webhook. |
(WebhookLinks (object or null)) |
Response samples
- 200
- 401
- 403
- 404
- 500
{- "id": 0,
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "topics": [
- "string"
], - "url": "string",
- "authorization_header": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "webhook:delete": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "webhook:ping": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "webhook:update": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}
Update a webhook
Authorizations:
write:webhooks
) path Parameters
webhookId required | integer <int32> |
Request Body schema: application/json
name | string or null The name of the webhook. |
url | string or null The server endpoint that will receive the webhook payload. |
authorization_header | string or null The Authorization header value that should be included in requests to the webhook. |
topics | Array of strings or null An array of the topics the webhook is trigger for. |
Responses
Response Schema: application/hal+json
id | integer or null <int32> The webhook identifier. |
name | string or null The name of the webhook. |
created_at | string <date-time> The date when the webhook was created. |
topics | Array of strings or null An array of the topics the webhook is trigger for. |
url | string or null The server endpoint that will receive the webhook payload. |
authorization_header | string or null The Authorization header value that should be included in requests to the webhook. |
(WebhookLinks (object or null)) |
Request samples
- Payload
{- "name": "string",
- "url": "string",
- "authorization_header": "string",
- "topics": [
- "string"
]
}
Response samples
- 200
- 400
- 401
- 403
- 500
{- "id": 0,
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "topics": [
- "string"
], - "url": "string",
- "authorization_header": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "webhook:delete": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "webhook:ping": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "webhook:update": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}
Delete a webhook
Authorizations:
write:webhooks
) path Parameters
webhookId required | integer <int32> |
Responses
Response samples
- 401
- 403
- 500
{- "code": "string",
- "message": "string",
- "errors": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}
}
Ping a webhook
Triggers a request to be sent to your webhook. Call this endpoint to test your webhook.
Authorizations:
write:webhooks
) path Parameters
webhookId required | integer <int32> |
Responses
Response samples
- 202
- 400
- 401
- 403
- 500
{- "id": 0,
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "topics": [
- "string"
], - "url": "string",
- "authorization_header": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "webhook:delete": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "webhook:ping": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "webhook:update": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}
Returned for monetary values, such as ticket prices, fees charged and tax amounts.
amount required | number or null <decimal> The decimal amount of the money. |
currency_code required | string or null The ISO 4217 currency code that the monetary value is represented in. |
display | string or null A user-friendly string representing the monetary value. |
{- "amount": 0,
- "currency_code": "string",
- "display": "string"
}
A webhook is a subscription from a server application to certain topics on the viagogo platform. When an occurrence of a topic is triggered, we’ll POST a payload to the webhook’s configured url.
id | integer or null <int32> The webhook identifier. |
name | string or null The name of the webhook. |
created_at | string <date-time> The date when the webhook was created. |
topics | Array of strings or null An array of the topics the webhook is trigger for. |
url | string or null The server endpoint that will receive the webhook payload. |
authorization_header | string or null The Authorization header value that should be included in requests to the webhook. |
(WebhookLinks (object or null)) |
{- "id": 0,
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "topics": [
- "string"
], - "url": "string",
- "authorization_header": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "webhook:delete": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "webhook:ping": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "webhook:update": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}
total_items | integer or null <int32> |
page | integer or null <int32> |
page_size | integer or null <int32> |
(WebhooksLinks (object or null)) | |
(WebhooksEmbeddedResources (object or null)) |
{- "total_items": 0,
- "page": 0,
- "page_size": 0,
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "first": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "last": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "next": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "prev": {
- "href": "string",
- "title": "string",
- "templated": true
}
}, - "_embedded": {
- "items": [
- {
- "id": 0,
- "name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "topics": [
- "string"
], - "url": "string",
- "authorization_header": "string",
- "_links": {
- "self": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "webhook:delete": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "webhook:ping": {
- "href": "string",
- "title": "string",
- "templated": true
}, - "webhook:update": {
- "href": "string",
- "title": "string",
- "templated": true
}
}
}
]
}
}