Background

The app is not displayed in the UI. It runs continuously in the background to receive special events.

Example manifest

"location": {
  "support": {
    "background": "assets/iframe.html"
  }
},

See Setting the app location.

The objects available in all locations are available in this location.

Events

In addition to the core events, the following event is available to an app in the background:

  • ticket.saved

The ticket.saved event corresponds to the completion of the server-side ticket save action. The event is supported for apps that run in the background location. Note that this event does not fire in the ticket_sidebar or new_ticket_sidebar locations because they are generally removed from the interface before this event fires.

The event handler receives a Ticket object as a single argument.

Example:

client.on('ticket.saved', function(data) {
  console.log('ticket ' + data.ticket.id + ' saved!');
});