Skip to main content
logo
Documentation Powered by Redocly

StubHub Webhooks API (2.249.0.0)

Topics

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:
OAuth2
Request Body schema: application/json
barcodes
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

Content type
application/json
{
  • "barcodes": [
    ],
  • "topic": "string",
  • "action": "string",
  • "_links": {
    },
  • "_embedded": {
    }
}

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:
OAuth2
Request Body schema: application/json
barcodes
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

Content type
application/json
{
  • "barcodes": [
    ],
  • "topic": "string",
  • "action": "string",
  • "_links": {
    },
  • "_embedded": {
    }
}

CancelProvisionalSale Webhook

Triggered when a provisional sale is cancelled.

Authorizations:
OAuth2
Request Body schema: application/json
barcodes
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

Content type
application/json
{
  • "barcodes": [
    ],
  • "topic": "string",
  • "action": "string",
  • "_links": {
    },
  • "_embedded": {
    }
}

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:
OAuth2
Request Body schema: application/json
barcodes
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 FailedBarcodeValidation

(SaleUpdatesTopicLinks (object or null))
(SaleUpdatesTopicEmbeddedResources (object or null))

Responses

Request samples

Content type
application/json
{
  • "barcodes": [
    ],
  • "topic": "string",
  • "action": "string",
  • "_links": {
    },
  • "_embedded": {
    }
}

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:
OAuth2
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 FailedBarcodeValidation or ListingDeliverabilityExpired

barcodes
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

Content type
application/json
{
  • "topic": "string",
  • "action": "string",
  • "barcodes": [
    ],
  • "_links": {
    },
  • "_embedded": {
    }
}

Ping Webhook

Triggered any time a Webhook is pinged.

Authorizations:
OAuth2
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

Content type
application/json
{
  • "topic": "string",
  • "action": "string",
  • "_links": {
    },
  • "_embedded": {
    }
}

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:
OAuth2
Request Body schema: application/json
barcodes
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

Content type
application/json
{
  • "barcodes": [
    ],
  • "topic": "string",
  • "action": "string",
  • "_links": {
    },
  • "_embedded": {
    }
}

Webhooks

List webhooks

List webhooks for the authenticated user.

Authorizations:
OAuth2
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 created_at.

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

Content type
application/hal+json
{
  • "total_items": 0,
  • "page": 0,
  • "page_size": 0,
  • "_links": {
    },
  • "_embedded": {
    }
}

Create a webhook

Authorizations:
OAuth2
Request Body schema: application/json
One of
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

Content type
application/json
{
  • "name": "string",
  • "url": "string",
  • "authorization_header": "string",
  • "topics": [
    ]
}

Response samples

Content type
application/hal+json
{
  • "id": 0,
  • "name": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "topics": [
    ],
  • "url": "string",
  • "authorization_header": "string",
  • "_links": {
    }
}

Get a webhook

Authorizations:
OAuth2
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

Content type
application/hal+json
{
  • "id": 0,
  • "name": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "topics": [
    ],
  • "url": "string",
  • "authorization_header": "string",
  • "_links": {
    }
}

Update a webhook

Authorizations:
OAuth2
path Parameters
webhookId
required
integer <int32>
Request Body schema: application/json
One of
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

Content type
application/json
{
  • "name": "string",
  • "url": "string",
  • "authorization_header": "string",
  • "topics": [
    ]
}

Response samples

Content type
application/hal+json
{
  • "id": 0,
  • "name": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "topics": [
    ],
  • "url": "string",
  • "authorization_header": "string",
  • "_links": {
    }
}

Delete a webhook

Authorizations:
OAuth2
path Parameters
webhookId
required
integer <int32>

Responses

Response samples

Content type
application/hal+json
{
  • "code": "string",
  • "message": "string",
  • "errors": {
    }
}

Ping a webhook

Triggers a request to be sent to your webhook. Call this endpoint to test your webhook.

Authorizations:
OAuth2
path Parameters
webhookId
required
integer <int32>

Responses

Response samples

Content type
application/hal+json
{
  • "id": 0,
  • "name": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "topics": [
    ],
  • "url": "string",
  • "authorization_header": "string",
  • "_links": {
    }
}

Money

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"
}

Webhook

A webhook is a subscription from a server application to certain topics on the StubHub 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": [
    ],
  • "url": "string",
  • "authorization_header": "string",
  • "_links": {
    }
}

Webhooks

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": {
    },
  • "_embedded": {
    }
}