How can I open a top nav app automatically with Zendesk Apps V2?

Question

Can I automatically open a top nav app? 

Answer

You can open a top nav when the app is first loaded however you cannot do this directly from a top nav app. Top nav apps are not loaded into the DOM and therefore available to make requests until they are first opened. For more information, see this page: preloadPane.

To workaround this, make this request from an app in another location using the instances API (ticket sidebar, side nav, or ideally a background app). For example, have the app locations set to both top_bar and background in your manifest: 

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

Because the app is configured to also be in the background location which loads immediately, you are then able to use the background app and the instances API to pop open the top nav app automatically.

var client = ZAFClient.init();

var topBarClientPromise = client.get('instances').then(function(instancesData) {
  var instances = instancesData.instances;
  for (var instanceGuid in instances) {
    if (instances[instanceGuid].location === 'top_bar') {
      return client.instance(instanceGuid);
    }
  }
});

topBarClientPromise.then(function(topBarClient) {
  // opens the top bar app, even if its iframe hasn't been loaded
  topBarClient.invoke('popover');
});

For more information, see the article: Messaging between locations.

Disclaimer: This article is provided for instructional purposes only. Zendesk does not support or guarantee the code. Post any issues you have in the comments section or try searching for a solution online.