Webhooks General Information

We offer webhooks for the variety of event that can potentially occur in the Shows On Sale system.

Format of a webhook message

{
    "id" : string,
    "ids" : string[],
    "action" : string,
    "timestamp" : datetime,
}

The id or ids field will be present in the webhook message depending on the action.

• id will be present if the action is related to a single entity.
• ids will be present if the action is related to multiple entities.

The timestamp will be the date and time when the event occurred. It is UTC, and in the format YYYY-MM-DDTHH:MM:SS.ffffff+00:00.

Action types

• NewEvents

  • Returns when a new event, or multiple new events are added to the system.

• NewSale

  • Returns when a new sale is added to an existing event.

• UpdatedEvent

  • Returns when metadata for an event is updated.

• UpdatedSale

  • Returns when metadata for a sale is updated.

• UpdatedInventory (coming soon)

Example

{
  "id": "evt_NONJ5YJ62X",
  "ids": [],
  "action": "UpdatedSale",
  "timeStamp": "2024-06-10T18:25:11.6084679+00:00"
}

More information

If you need more information an event or sale, you'll need to all the the event information API API.