Meta tags:
description=Developer documentation for products at Zendesk;

Headings (most frequently used words):

returns, apps, api, app, get, core, on, this, page, registered, instance, window, resize, instances, invoke, arguments, support, chat, sell, events, properties, actions, activated, deactivated, expanded, collapsed, created, scroll, requirement, asseturl, iscollapsed, viewport, size, create, limitations,

Text of the page (most frequently used words):
the (115), app (53), sidebar (32), instance (25), when (25), apps (23), and (22), this (20), api (20), ticket (20), for (17), client (16), #window (14), event (14), fires (14), locations (13), location (12), registered (12), instances (11), new (11), returns (11), zendesk (10), created (10), object (10), get (10), can (9), support (9), resize (9), all (9), only (8), modal (8), containing (8), your (8), user (8), events (8), properties (7), height (7), iframe (7), invoke (7), available (7), use (7), note (7), core (7), bar (7), create (6), that (6), width (6), size (6), see (6), you (6), example (6), viewport (6), actions (6), state (6), chat (6), are (6), will (6), context (6), has (5), one (5), instanceguid (5), following (5), url (5), loaded (5), organization (5), collapsed (5), background (5), from (5), expanded (5), becomes (5), once (4), modals (4), dimensions (4), its (4), return (4), agent (4), tab (4), top (4), iscollapsed (4), includes (4), string (4), first (4), asseturl (4), requirement (4), equivalent (4), sdk (4), status (3), developer (3), always (3), may (3), more (3), been (3), another (3), 9e012b1f (3), 1397 (3), 484e (3), 8810 (3), c444b8085e55 (3), assets (3), value (3), arguments (3), such (3), additional (3), innerwidth (3), log (3), switches (3), activated (3), values (3), nav (3), browser (3), current (3), property (3), which (3), backslash (3), logo (3), png (3), integer (3), depending (3), requirement_id (3), each (3), also (3), after (3), ticket_sidebar (3), there (3), function (3), argument (3), every (3), reloaded (3), clicks (3), reload (3), shortcuts (3), tickets (3), active (3), editor (3), introduction (3), returned (2), array (2), future (2), than (2), case (2), would (2), promise (2), framework (2), open (2), time (2), desired (2), with (2), directory (2), product (2), must (2), set (2), options (2), console (2), debounce (2), whenever (2), fired (2), best (2), where (2), take (2), cannot (2), resized (2), limitations (2), true (2), using (2), resource (2), specifying (2), requirements (2), requirement_type (2), identifier (2), information (2), subdomain (2), have (2), scrolltop (2), invoked (2), handler (2), receives (2), most (2), 1000 (2), milliseconds (2), scroll (2), button (2), not (2), ticketinstance (2), like (2), feature (2), pinned (2), unpinned (2), inactive (2), mean (2), different (2), things (2), deactivated (2), existing (2), other (2), listen (2), load (2), notes (2), sell (2), zaf (2), page (2), zendev_horizontal (2), system, terms, privacy, notice, 181, fremont, street, 17th, floor, san, francisco, california, 94105, slack, blog, forum, join, our, community, element, longer, resolves, visible, screen, delayed, already, since, shown, resolving, metadata, optional, absolute, start, relative, uploaded, specific, creates, specified, become, 200, resizeapp, addeventlistener, listener, automatically, adjust, changes, ensure, dynamically, calculating, considered, practice, prevent, resizing, issue, body, while, original, was, still, process, being, scrollheight, 80vh, 80vw, don, percentage, pixel, they, maximum, space, wider, 320px, some, resultant, 750px, 300px, resizes, 768, 1024, errors, false, dots, commas, filename, name, escaped, add, single, literal, need, escapes, second, demonstrated, https, fully, qualified, pointing, file, types, listed, underlying, fields, but, webhooks, type, keyed, contents, account, host, establish, cross, communication, calls, further, usage, details, represents, running, two, tabs, interface, runs, three, top_bar, scrolled, position, innerheight, registers, might, yet, needs, something, regards, comment, appendtext, var, useful, cases, want, interact, transient, permanent, handlers, bound, receive, data, just, about, messaging, between, zafclient, collapse, persists, across, away, same, similarly, done, help, managing, differs, navigates, their, occurs, displayed, performance, reasons, wait, noted, description, below, debounced, supplemented, access, products, visit, composer, call, person, lead, deal, company, home, search, reference, documentation, docs,

Text of the page (random words):
core apps api zendesk developer docs zendev_horizontal zendev_horizontal documentation api reference search apps apps core api home apps apps apps core api zaf client api core apps api apps support api introduction all locations ticket and new ticket sidebar organization sidebar user sidebar top bar nav bar modal ticket editor background apps chat api introduction all locations chat sidebar background apps sell api introduction all locations background company sidebar deal sidebar lead sidebar person sidebar top bar call log editor modal note editor visit composer on this page events properties actions core apps api on this page events properties actions the following core events properties and actions are available in all locations in all products that support the zendesk apps framework events properties actions use the zaf client in your app to listen for the events access the properties or invoke the actions this api is supplemented by the support apps api the chat apps api and the sell apps api events app registered app activated app deactivated app expanded app collapsed instance created instance registered window resize window scroll note the window events are debounced in apps for performance reasons debounce wait values are noted in each window event s description below app registered fires when the app is loaded it also fires when the app is reloaded such as when the agent clicks the reload all apps button notes apps in the top bar and nav bar load only when the user navigates to their locations and clicks on the app this event occurs only when the app is first displayed app activated fires when the app becomes active this can mean different things depending on the location for example if the app is in the ticket sidebar the app becomes active when the user switches to the tab containing this instance of your app notes this event differs from the app registered event in that it fires when the app becomes active not when the app is loaded use app registered to listen for load events when an app is pinned or unpinned to the app shortcuts of an existing ticket it will reload the same app in all other existing tickets similarly if it is done in a new ticket the app will be reloaded in all other new tickets see managing app shortcuts in zendesk help app deactivated fires when the app becomes inactive this can mean different things depending on the location for example if the app is in the ticket sidebar the app becomes inactive when the user switches away from the tab containing this instance of your app app expanded fires when the app is expanded from a collapsed state this feature is only available in sidebar locations which includes ticket sidebar new ticket sidebar user sidebar organization sidebar and chat sidebar note there is no collapse state in app shortcuts the expanded state will be true every time when an app is pinned or unpinned the state persists across tickets app collapsed fires when the app is collapsed from an expanded state this feature is only available in sidebar locations which includes ticket sidebar new ticket sidebar user sidebar organization sidebar and chat sidebar instance created fires when another instance of your app is created this is useful in cases where you want to interact with transient locations like the ticket sidebar in zendesk support from a permanent location like the background location in zendesk support event handlers bound to instance created receive the context data for the instance just created you can use the instanceguid property of the context to create a zafclient using the instance api for more information about the instances api see messaging between locations example background location client on instance created function context if context location ticket_sidebar var ticketinstance client instance context instanceguid ticketinstance invoke comment appendtext best regards note the sdk client in that location might not have been registered yet when this event is fired if your app needs to do something only after the sdk client has been registered see instance registered instance registered fires when an app instance is loaded and registers a sdk client it also fires when the app is reloaded such as when the agent clicks the reload all apps button window resize fires when the current browser window is resized the event fires at most once every 33 1000 30 milliseconds when invoked by this event the handler function receives an event object as its first argument and the following additional arguments width equivalent to window innerwidth height equivalent to window innerheight window scroll fires when the current browser window is scrolled to a new position the event fires at most once every 16 1000 60 milliseconds when invoked by this event the handler function receives an event object as its first argument and the following additional argument scrolltop equivalent to window scrolltop properties instances requirement asseturl iscollapsed viewport size instances represents the running instances of the app there is one instance for each iframe for example if there are two ticket tabs open in the agent interface and an app runs in the top_bar and ticket_sidebar locations the app will have three instances you can use this api to establish cross location communication and api calls see client instance for further usage details get client get instances returns instances 9e012b1f 1397 484e 8810 c444b8085e55 instanceguid 9e012b1f 1397 484e 8810 c444b8085e55 host zendesk product support location ticket_sidebar account subdomain subdomain status registered each instance is keyed by its instanceguid the contents of the instance object are equivalent to that iframe s context the instance also includes a status property set to created after the instance is created and registered after the iframe is loaded and the sdk client has registered requirement returns an object containing a requirement_id and a requirement_type for more information see specifying app requirements get client get requirement identifier returns requirement identifier requirement_id string integer requirement_type resource type requirement_id may return a string or an integer depending on the underlying object s id for example ticket fields will return an integer but webhooks will return a string note resource types available are listed in specifying apps requirements asseturl returns a fully qualified url pointing to a file in the app s assets directory get client get asseturl logo png returns asseturl logo png https logo png note dots and commas in the filename name must be escaped using a backslash to add a single backslash in a string literal you need to use as the first backslash escapes the second one this can be demonstrated by console log iscollapsed returns the current collapsed state of the app this property is only available for sidebar locations which includes ticket sidebar new ticket sidebar user sidebar organization sidebar and chat sidebar get client get iscollapsed returns iscollapsed true false viewport size returns the size of the browser window viewport get client get viewport size returns errors viewport size width 1024 height 768 actions resize instances create resize resizes the app s iframe dimensions invoke client invoke resize width 300px height 750px arguments object containing the desired dimensions width and height in px or vw vh for modals returns object containing the resultant dimensions limitations the resize api has the following limitations in some locations ticket user and organization sidebar apps cannot be wider than 320px nav bar apps cannot be resized they always take the maximum space available top bar apps don t support percentage values use pixel values modals can take up to 80 of the viewport 80vh and 80vw note ensure that you always invoke a resize whenever the app activated core event is fired if your app is dynamically calculating it s height this is considered as a best practice to prevent a resizing issue where the body scrollheight of the iframe would return a value of 0 whenever an agent switches to another ticket tab while your app in the original tab was still in the process of being loaded you can use a resize event listener to automatically adjust the height of your app when its width changes in ticket sidebar or new ticket sidebar for example window addeventlistener resize debounce console log innerwidth window innerwidth resizeapp 200 instances create creates a new iframe instance of the app in a specified location such as a modal in zendesk support see modal additional locations may become available in the future invoke client invoke instances create options arguments options an object containing the following properties location a product specific value in zendesk support the value must be set to modal url the url of the new iframe the url can be an absolute url or start with assets if it is relative to the uploaded app s assets directory size optional object containing the desired dimensions width and height in px or vw vh for modals returns a promise resolving to an object containing metadata for the new instance instances create instanceguid 9e012b1f 1397 484e 8810 c444b8085e55 the returned promise resolves once the instance has been created by the framework in the case of modals the instance is only created once the modal is visible on the screen it is delayed if another modal is already open since only one modal can be shown at a time the returned array always has one element in a future location this api may create more than one instance in that case the array would be longer join our developer community forum blog slack zendesk 181 fremont street 17th floor san francisco california 94105 privacy notice zendesk developer terms system status