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

Headings (most frequently used words):

client, arguments, returns, api, apps, name, on, handler, this, page, zafclient, object, context, invoke, obj, set, zaf, core, support, chat, sell, init, get, paths, has, instance, guid, args, metadata, off, request, options, key, val, trigger, data, example, argument,

Text of the page (most frequently used words):
the (92), #client (64), api (30), ticket (27), apps (27), data (26), object (24), zafclient (23), you (22), name (22), function (21), app (20), var (19), for (19), console (18), init (18), response (18), log (17), request (17), type (16), then (15), example (14), handler (13), arguments (13), get (12), set (11), can (11), sidebar (11), event (10), value (10), true (10), json (10), string (10), returns (9), and (9), boolean (9), this (9), context (9), invoke (9), subject (8), javascript (8), path (8), has (8), with (8), from (8), instance (8), zendesk (7), call (7), support (7), core (7), see (7), false (7), zaf (7), registered (7), printer (6), incident (6), promise (6), values (6), that (6), chat (6), paths (6), http (6), options (6), framework (6), metadata (6), location (6), instances (6), obj (5), some (5), sell (5), url (5), text (5), application (5), requests (5), appregistered (5), bar (5), instanceguid (5), locations (5), status (4), trigger (4), want (4), overheating (4), specify (4), supported (4), headers (4), tickets (4), method (4), use (4), additional (4), server (4), all (4), your (4), events (4), priority (4), hide (4), help (4), top (4), top_bar (4), ticket_sidebar (4), requester (4), developer (3), optional (3), containing (3), key (3), segments (3), take (3), using (3), colon (3), syntax (3), complete (3), list (3), responsetext (3), error (3), httpcompleteresponse (3), timeout (3), contenttype (3), such (3), domain (3), properties (3), requested (3), mime (3), allows (3), default (3), header (3), not (3), array (3), makes (3), browser (3), are (3), when (3), following (3), note (3), add (3), like (3), they (3), off (3), comment (3), appendtext (3), ticketfields (3), product (3), iframe (3), guid (3), editor (3), background (3), introduction (3), activating (2), activation (2), pass (2), triggers (2), specified (2), keys (2), which (2), val (2), date (2), could (2), new (2), asynchronously (2), body (2), withcredentials (2), xhrfields (2), www (2), com (2), datatype (2), keyexample (2), cache (2), autoretry (2), custom (2), accepts (2), cross (2), resource (2), possible (2), traditional (2), parameter (2), flag (2), secure (2), settings (2), sending (2), back (2), send (2), stringify (2), forces (2), content (2), its (2), gets (2), argument (2), sdk (2), many (2), handlers (2), called (2), within (2), listen (2), also (2), available (2), stuff (2), remove (2), attached (2), installation (2), plan (2), information (2), been (2), args (2), field (2), actions (2), topbarclient (2), topbarclientpromise (2), instancesdata (2), assets (2), html (2), fire (2), mikkel (2), svane (2), host (2), methods (2), script (2), page (2), modal (2), zendev_horizontal (2), system, terms, privacy, notice, 181, fremont, street, 17th, floor, san, francisco, california, 94105, slack, blog, forum, join, our, community, update, due, task, customfield, due_date, sets, either, success, statustext, responsejson, 200, native, xmlhttprequest, post, put, delete, patch, uses, style, serialization, period, milliseconds, number, allow, used, override, xhr, mimetype, web, token, encoding, jwts, jwt, successful, only, changed, since, last, ifmodified, full, including, pairs, along, expected, converted, query, already, ensure, same, crossdomain, proxy, defaults, apis, always, made, regardless, option, cors, specifies, form, urlencoded, charset, utf, pages, cached, overrides, auto, retry, behavior, rate, limiting, maps, given, sent, accept, description, combination, their, case, sensitive, making, soon, communication, established, immediately, after, callback, nuts, fires, working, wish, will, executed, order, were, added, earlier, title, starter, stripe_subscription_id, sub_1234567890abcdefg, version, installationid, 12345, appid, 123, stripe, subscription, applicable, appended, returned, arrays, passed, executes, action, identified, multiple, defined, interface, popover, opens, even, hasn, loaded, return, runs, code, must, run, manifest, would, contain, snippet, demonstrates, how, open, transient, tab, closed, destroyed, desired, 9e012b1f, 1397, 484e, 8810, c444b8085e55, otherclient, initialize, another, activated, test, whether, strings, single, retrieve, about, ticketfield, ticketid, 1234, subdomain, mondocam, account, 7712c893, bec7, 4e00, 9db0, 87fbb0c12914, depending, may, provide, identifiers, rest, https, static, zdassets, zendesk_app_framework_sdk, zaf_sdk, min, src, include, website, access, lets, communicate, provides, building, visit, composer, person, lead, deal, company, nav, user, organization, home, search, reference, documentation, docs,

Text of the page (random words):
zaf client 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 zafclient object client object zaf client api on this page zafclient object client object the zaf client lets your app in the iframe communicate with the host zendesk product you can use the client in your apps to listen for events get or set properties or invoke actions the zaf client also provides additional methods for building apps example var client zafclient init client get ticket requester name then function data console log data ticket requester name mikkel svane zafclient object when you include the zaf sdk on your website you get access to the zafclient object script type text javascript src https static zdassets com zendesk_app_framework_sdk 2 0 zaf_sdk min js script the zafclient object has the following method init zafclient init returns a client object example var client zafclient init client object methods context get has instance invoke metadata off on request set trigger client context requests context for the app such as the host and location depending on the location the context may provide additional identifiers that you can use with the rest api to request additional data returns a javascript promise object var client zafclient init client context then function context console log context instanceguid 7712c893 bec7 4e00 9db0 87fbb0c12914 product support account subdomain mondocam location ticket_sidebar ticketid 1234 client get paths gets data from the ui asynchronously for a complete list of supported paths see core apps api support apps api chat apps api sell apps api some path segments can take arguments that you can specify using a colon syntax for example to retrieve information about the options available to the type ticket field you could call client get ticketfield type options arguments paths an array of path strings or a single path string returns a javascript promise object var client zafclient init client get ticket subject then function data console log data ticket subject help my printer is on fire or client get ticket subject ticket requester name then function data console log data ticket subject help my printer is on fire ticket requester name mikkel svane client has name handler returns whether or not an event has the specified handler attached to it arguments name the name of the event handler the handler you want to test var client zafclient init client on app registered function appregistered e do stuff client has app registered appregistered true client has app activated appregistered false client instance guid initialize a zafclient for another location var client zafclient init var otherclient client instance 9e012b1f 1397 484e 8810 c444b8085e55 arguments instanceguid the guid for the desired instance of the app returns an instance of zafclient for the requested instance guid note that instances are transient in some locations like ticket sidebar so if the ticket tab is closed that instance is destroyed example this example demonstrates how to open a top bar app from a ticket sidebar iframe the app in this example must run in the top_bar and ticket_sidebar locations the manifest would contain a snippet like this location support ticket_sidebar assets ticket_sidebar html top_bar assets top_bar html the ticket sidebar app runs the following code 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 client invoke name args client invoke obj executes an action identified by the name path parameter or multiple actions defined in the obj argument within the product interface for a complete list of supported paths see core apps api support apps api chat apps api sell apps api some path segments can take arguments that you can specify using a colon syntax for example to hide the priority ticket field call client invoke ticketfields priority hide arguments name the path to call args optional arguments to be passed to the call or obj an object containing invoke paths as keys and arrays of arguments as values returns a javascript promise object with the value returned from the method call s var client zafclient init client invoke ticket comment appendtext help then function console log text has been appended or client invoke ticket comment appendtext help ticketfields priority hide then function data console log data ticket comment appendtext value ticketfields priority hide value client metadata requests metadata for the app such as the app id installation id app plan information and stripe subscription id if applicable returns a javascript promise object var client zafclient init client metadata then function metadata console log metadata appid 123 name my app installationid 12345 version 1 0 stripe_subscription_id sub_1234567890abcdefg plan name starter settings title my installation name client off name handler allows you to remove a handler for a framework event arguments name the name of the event handler the function you attached earlier with on var client zafclient init client on app registered function appregistered e do stuff then remove the handler client off app registered appregistered client on name handler context allows you to add handlers to a framework event you can add as many handler as you wish they will be executed in the order they were added for available events see core apps api support apps api chat apps api sell apps api see also working with framework events arguments name the name of the framework event you want to listen to this can be framework request or custom events handler a function to be called when this event fires context optional the value of this within your handler var client zafclient init client on app registered function e go nuts note as soon as communication with the framework is established the sdk triggers an app registered event you can add as many handlers to app registered as you like they re called immediately after the init callback client request options makes an http request see making api requests from a zendesk app argument options the url of the resource to request or an object containing a combination of the following properties with their supported values all values are case sensitive options type description accepts object maps a given data type to its mime type which gets sent in the accept request header autoretry boolean if true overrides the default auto retry behavior of the request in response to rate limiting cache boolean if false forces requested pages not to be cached by the browser contenttype boolean string specifies the content type when sending data to a server if set to false then no content type header is set default value application x www form urlencoded charset utf 8 example application json cors boolean if true makes a request from the browser if false makes a request from a zendesk proxy server defaults to false requests to zendesk apis are always made from the browser regardless of this option crossdomain boolean if true forces a cross domain request on the same domain data object string array data to send to the server converted to a query string if not already a string if you pass a javascript object or array and you specify application json as the contenttype use the json stringify method to ensure the data is a json string for example data json stringify keyexample value example datatype string type of data expected back from the server possible values text json headers object additional header key value pairs to send along with the request httpcompleteresponse boolean flag to get a full response back including the headers and the response status default value is false ifmodified boolean allows the request to be successful only if the response has changed since the last request jwt object a json web token see encoding and sending zaf jwts mimetype string mime type to override the xhr mime type secure boolean flag to allow secure settings to be used timeout number timeout period in milliseconds for the request traditional boolean if true uses the traditional style of parameter serialization type string the http method to use possible values get post put delete patch url string url of the requested resource xhrfields object native xmlhttprequest properties such as withcredentials true for cross domain requests example options accepts text application x some custom type autoretry true cache false contenttype application json data keyexample value example datatype text httpcompleteresponse true type get timeout 200 url www example com xhrfields withcredentials true returns a javascript promise object var client zafclient init client request api v2 tickets json then function tickets console log tickets function response console error response responsetext or var client zafclient init client request url api v2 tickets json httpcompleteresponse true then function response console log response responsejson body of the http response console log response responsetext body of the http response console log response status http response status console log response statustext is either success or error console log response headers http response headers function response console error response responsetext client set key val client set obj sets data in the ui asynchronously for a complete list of supported paths see core apps api support apps api chat apps api sell apps api some path segments can take arguments that you can specify using a colon syntax for example to set the due date of a task you could call client set ticket customfield due_date new date arguments key the path to which to set the value val or obj an object containing the keys and values to update returns a javascript promise object var client zafclient init client set ticket subject printer overheating incident then function data console log data ticket subject printer overheating incident or client set ticket subject printer overheating incident ticket type incident then function data console log data ticket subject printer overheating incident ticket type incident client trigger name data triggers the specified event on the client arguments name the name of the event you want to trigger data optional data you want to pass to the handler var client zafclient init client on activation function console log activating client trigger activation activating join our developer community forum blog slack zendesk 181 fremont street 17th floor san francisco california 94105 privacy notice zendesk developer terms system status