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

Headings (most frequently used words):

parameters, example, set, examples, conversation, web, widget, message, on, this, page, delegate, before, user, metadata, create, new, error, callback, core, messaging, api, zendesk, and, sdks, android, ios, unity, show, hide, open, close, custom, launcher, locale, zindex, cookies, fields, tags, behavior, sent, display, update, reset, customization, ui, programmatic, send, fetch, conversations, get, config, navigation, embedded, mode, return, value, notes, disabling, auto, rendering, container, availability,

Text of the page (most frequently used words):
the (340), conversation (156), #message (155), error (101), widget (86), object (85), messenger (81), set (80), string (74), type (57), metadata (57), and (52), callback (52), when (44), web (42), api (41), function (40), for (39), console (36), with (34), log (32), only (31), user (31), text (31), number (30), messaging (29), mode (26), parameters (26), description (25), null (25), not (24), content (23), example (23), property (23), this (22), value (22), has (21), configuration (21), config (20), you (20), page (20), required (20), boolean (20), default (20), fields (20), use (19), create (19), must (19), screen (19), new (19), reason (18), parameter (18), from (18), custom (18), customization (18), before (17), following (17), offset (17), cookies (17), will (16), embedded (16), that (16), response (16), displayname (16), creation (16), created (16), ticket (16), conversations (15), failed (15), called (15), data (15), return (15), are (15), support (15), key (14), behavior (14), all (14), render (13), conversationlist (13), list (13), false (13), none (13), optional (13), end (13), true (13), newconversation (13), locale (13), tags (13), container (12), structure (12), display (12), position (12), side (12), can (12), zendesk (11), your (11), one (11), options (11), pairs (11), settings (11), header (11), messagelog (10), messages (10), name (10), note (10), supported (10), yes (10), update (10), order (10), send (10), initial (10), values (10), avatar (10), vertical (10), horizontal (10), range (10), reset (10), field (10), conversationid (9), fetch (9), hide (9), read (9), element (8), targetelement (8), left (8), errorcallback (8), examples (8), invalid (8), successful (8), receives (8), used (8), launcher (8), identifier (8), timestamp (8), need (8), existing (8), after (8), conversationfields (8), analytics (8), was (7), specific (7), first (7), full (7), properties (7), which (7), navigation (7), non (7), sent (7), empty (7), provided (7), immediately (7), any (7), customize (7), hideheader (7), hides (7), original (7), logo (7), composer (7), core (7), const (6), handling (6), want (6), floating (6), about (6), result (6), navigate (6), associated (6), icon (6), iconurl (6), index (6), right (6), theme (6), pixels (6), 100 (6), apply (6), see (6), modified (6), delegate (6), focus (6), open (6), status (5), view (5), successfully (5), handle (5), next (5), descriptive (5), contains (5), either (5), automatically (5), navigates (5), button (5), using (5), get (5), state (5), received (5), more (5), url (5), array (5), request (5), 12345 (5), help (5), receivedat (5), whitespace (5), undefined (5), conversationcreationerror (5), conversationoptions (5), programmatic (5), including (5), hidden (5), businessmessage (5), common (5), mobile (5), distance (5), admin (5), center (5), applied (5), uses (5), appearance (5), color (5), out (5), unsubscribe (5), author (5), allows (5), conversationtags (5), sdks (5), zindex (5), close (5), show (5), missing (4), method (4), its (4), where (4), css (4), information (4), should (4), multi (4), mostrecentactiveconversation (4), active (4), current (4), orderid (4), sendmessage (4), flat (4), attach (4), hidebubble (4), bubblemaxwidth (4), usermessage (4), bubbles (4), ffffff (4), bubble (4), agent (4), resetwidget (4), conversationmetadata (4), authentication (4), these (4), users (4), being (4), two (4), modify (4), call (4), functional (4), developer (3), make (3), sure (3), dom (3), calling (3), logged (3), split (3), rendered (3), else (3), selector (3), div (3), doesn (3), without (3), renderfailederror (3), additional (3), details (3), cause (3), least (3), each (3), accepts (3), omitted (3), script (3), single (3), enabled (3), creates (3), available (3), whether (3), fetchconversations (3), hasmore (3), occurs (3), brand (3), brandid (3), objects (3), second (3), hello (3), unix (3), unique (3), have (3), priority (3), https (3), com (3), pre (3), chat (3), validation (3), ignored (3), instead (3), important (3), unchanged (3), operation (3), size (3), top (3), hidenewconversationbutton (3), contentscale (3), dynamic (3), adjust (3), background (3), displayed (3), session (3), percentage (3), customizes (3), elements (3), updates (3), executes (3), local (3), also (3), again (3), stores (3), cleared (3), sign (3), time (3), updated (3), keep (3), sales (3), then (3), would (3), 123456789 (3), sets (3), let (3), know (3), opted (3), storage (3), iframes (3), system (2), html (2), found (2), targetelementnotfound (2), specifying (2), target (2), exist (2), possible (2), reasons (2), identifies (2), provides (2), failure (2), explains (2), class (2), instance (2), why (2), indicating (2), include (2), component (2), how (2), renders (2), mandatory (2), prevent (2), rendering (2), disabling (2), auto (2), into (2), navigating (2), most (2), recent (2), requires (2), launchershape (2), multiconvoenabled (2), retrieves (2), loaded (2), pages (2), fetchconversationserror (2), unread (2), unreadcount (2), idle (2), last (2), lastupdatedat (2), createdat (2), per (2), date (2), checkout (2), source (2), order_inquiry (2), intent (2), sendmessageerror (2), level (2), sends (2), vip (2), high (2), 13377430 (2), png (2), technical (2), but (2), wrong (2), passed (2), populate (2), valid (2), title (2), unlike (2), does (2), success (2), appears (2), trigger (2), asynchronous (2), actions (2), opens (2), f3c178 (2), onprimary (2), fe5e41 (2), primary (2), edges (2), isrtl (2), point (2), lifecycle (2), well (2), changes (2), rtl (2), languages (2), language (2), globally (2), 000000 (2), f10404 (2), bottom (2), edge (2), contain (2), accepted (2), configured (2), behind (2), maximum (2), width (2), responsive (2), breakpoints (2), parts (2), defines (2), colors (2), dynamically (2), clears (2), such (2), conditions (2), application (2), returns (2), maps (2), agents (2), free (2), form (2), structured (2), enterprise (2), plan (2), usermetadata (2), updateuser (2), dispatched (2), later (2), remove (2), beforemessagedisplay (2), synchronous (2), returning (2), promise (2), attempts (2), warning (2), affect (2), registers (2), intercept (2), invoked (2), synchronously (2), add (2), beforemessagesent (2), modification (2), store (2), based (2), alttext (2), suppressautofocus (2), arrive (2), behavioroptions (2), computer_accessories (2), formatted (2), needs (2), fresh (2), aren (2), start (2), additionally (2), added (2), openwidget (2), properly (2), enum (2), stored (2), essential (2), newzindex (2), covers (2), newlocale (2), code (2), locales (2), public (2), load (2), zendev_horizontal (2), terms, privacy, notice, 181, fremont, street, 17th, floor, san, francisco, california, 94105, slack, blog, forum, join, our, community, present, availability, main, sidebar, types, javascript, embed, inside, appear, acts, placeholder, invalidcssselector, invalidtargetelement, invalidconfiguration, missingembeddedconfiguration, invalidmode, invalidargument, specifies, attempt, autorender, window, zemessenger, loads, integrates, directly, specified, containers, adjusting, dimensions, fit, fall, back, showing, works, notes, conv_12345, exists, screens, within, cannot, shape, square, circle, permitted, canusercreatemoreconversations, executed, hasn, yet, deferred, until, nextresponse, fetched, there, milliseconds, seconds, starting, pagination, negative, integer, paginated, 67890, simple, behalf, question, friday, personal, version, cases, access, connection, initialization, etc, once, control, intended, triggered, 110, combine, includes, getrtllocales, onlanguagechange, because, suited, layout, supports, switching, between, ltr, move, appropriate, whenever, positioning, 125, scale, onsecondaryaction, onnotify, ff007f, notify, onerror, ff1744, onbackground, dfe0e2, onbusinessmessage, fff, onaction, b0db43, action, 5f0f00, onmessage, initializes, through, fully, override, those, controls, applies, business, placement, relative, completely, adjusts, scaling, 200, across, both, palette, subset, allowing, many, aspects, hex, rgb, hsl, named, customizing, lets, customizationoptions, been, connections, completes, performs, checks, ensure, isn, pending, proceeding, helps, problems, race, abnormal, states, urgent, category, 9876, starts, attaches, arbitrary, defined, visible, context, require, setup, surfaced, west, region, sunshine, retroactively, jane, doe, partially, 500, debounce, multiple, rapid, calls, combined, sending, runs, customer, team, names, sender, modifying, modifications, thus, included, transcript, incoming, they, senders, toisostring, getsessionid, sessionid, getcurrentuserid, userid, every, removes, sensitive, recommended, addition, atlantic, alt, image, readers, defaults, translation, suppress, reader, announcement, company, suppresses, input, gains, runtime, computer, accessories, strings, tag, prerequisite, steps, client, contextual, learn, introduction, were, opening, total, associating, tickets, identified, already, allow, acceptable, currently, functionalities, absence, features, proactive, viewed, visitor, path, besides, unable, setting, deleted, three, categories, product, cookie, policy, mixture, 123, 999999, overlap, determine, other, greater, smaller, change, placed, snippet, command, takes, argument, codes, rest, endpoint, json, overrides, matching, same, their, browser, define, behaves, unreadmessages, closes, invoke, displays, host, don, unless, commands, entire, unity, ios, android, events, home, search, reference, documentation, docs,

Text of the page (random words):
left dynamic positioning for rtl languages because the position api can be called at any point in the widget lifecycle it is well suited for dynamic layout changes for example if your page supports switching between left to right ltr and right to left rtl languages you can move the widget to the appropriate side whenever the language changes function onlanguagechange locale const isrtl getrtllocales includes locale ze messenger set locale locale ze messenger set customization position side isrtl left right set a custom offset from the screen edges ze messenger set customization position offset web horizontal 32 vertical 24 mobile horizontal 16 vertical 16 combine side and offset ze messenger set customization position side left offset web horizontal 20 vertical 20 full customization example ze messenger set customization theme primary fe5e41 onprimary ffffff message f3c178 common contentscale 110 hideheader false conversationlist hidenewconversationbutton true hideheader false messagelog hideheader true position side right offset web horizontal 16 vertical 16 customize message bubbles ze messenger set customization messagelog businessmessage bubblemaxwidth 80 hidebubble false usermessage bubblemaxwidth 60 hidebubble true customize avatar ze messenger set customization messagelog avatar hidden false position top size 32 create new conversation ui ze messenger ui newconversation conversationoptions object errorcallback function creates a new conversation and immediately navigates to the message log this is an asynchronous operation intended for ui triggered actions the widget automatically opens to the new conversation view after creation use this api when you want to trigger a new conversation from your ui for example from a custom button note this api does not support message metadata for programmatic control with full callback support including response data and message metadata support use ze messenger newconversation instead parameters name type mandatory description conversationoptions object false configuration for the new conversation errorcallback function false a callback function to handle the result of the conversation creation conversation options object properties conversation options property type required description displayname string no conversation title iconurl string no icon url of the conversation metadata object no flat key value pairs of conversation metadata string number or boolean values message object no initial message to pre populate in the message log when the conversation is created when message is omitted the conversation is created without an initial message and behavior is unchanged when message is provided the message text appears immediately in the message log once the conversation is created the message object has the following structure property type required description message content object yes the content of the initial message message content type string yes must be text only text messages are supported message content text string yes the message text must be a non empty non whitespace string important message metadata is not supported by this api any metadata passed in the message object will be ignored to attach metadata to the initial message use ze messenger newconversation instead if message is provided but invalid wrong type empty or whitespace only text missing content etc an error is logged and the conversation is not created error callback when errorcallback is called it receives an error parameter which will be either null indicating a successful conversation creation an instance of conversationcreationerror which contains information about why the conversation creation failed the conversationcreationerror class has the following properties name type description message string a descriptive message that explains the error reason string provides additional details on the cause of the conversation creation failure type string identifies the error type as conversationcreationerror possible error reasons reason description invalid configuration one or more options in conversationoptions failed validation conversation creation failed user creation connection initialization or conversation creation failed after validation examples create conversation with default settings ze messenger ui newconversation create conversation with display name ze messenger ui newconversation displayname technical support create conversation with error callback ze messenger ui newconversation displayname support chat function error if error console error failed to create conversation error reason error message else console log conversation created successfully create conversation with an initial message ze messenger ui newconversation displayname support chat message content type text text i need help with my order 12345 function errorcallback error if error example error handling const type reason message error console error conversation creation failed reason message else console log conversation created successfully create conversation with full options and error handling ze messenger ui newconversation displayname support request iconurl https example com icon png metadata priority high orderid 12345 message content type text text i need help with my order 12345 note message metadata is not supported in this api create new conversation programmatic ze messenger newconversation conversationoptions object callback function error response creates a new conversation with callback support for handling success and error cases use this api when you need programmatic access to the conversation details error handling or want to attach metadata to the initial message unlike the ui version this api does not automatically navigate to the conversation and requires a callback function to handle the result parameters conversationoptions object optional parameter configuration for the new conversation property type required description description string no conversation description displayname string no conversation title iconurl string no icon url of the conversation must be a valid url metadata object no flat key value pairs of conversation metadata string number or boolean values only message object no initial message to pre populate in the message log when the conversation is created when message is omitted the conversation is created without an initial message when message is provided the message is sent immediately when the conversation is created the message object has the following structure property type required description message content object yes the content of the initial message message content type string yes must be text only text messages are supported message content text string yes the message text must be a non empty non whitespace string message metadata object no flat key value pairs of message level metadata string number or boolean if message is provided but invalid for example wrong type empty or whitespace only text or missing content an error is passed to the callback and the conversation is not created callback function required the callback receives an error conversationcreationerror null as the first parameter and a response as the second parameter when successful when an error occurs error is not null the error object object has the following structure type conversationcreationerror error type identifier reason string either invalid configuration or conversation creation failed message string a descriptive error message when successful error is null the response object object has the following structure id string the unique identifier of the conversation createdat number unix timestamp when the conversation was created lastupdatedat number unix timestamp of the last update displayname string null the conversation s display name iconurl string null the conversation s icon url status active idle the conversation status type string the conversation type e g personal brandid string null the brand identifier unreadcount number the number of unread messages examples create conversation with callback ze messenger newconversation displayname technical support error conversation if error console error failed error return console log created conversation create conversation with an initial message ze messenger newconversation displayname friday order message content type text text hello i need help with my order error conversation if error console error failed error message return console log created conversation id create an empty conversation ze messenger newconversation undefined error conversation if error console error error error message return console log created conversation id create conversation with message metadata ze messenger newconversation displayname vip support description order 13377430 iconurl https example com icon png metadata orderid 13377430 priority high vip true message content type text text i have a question about my order metadata intent order_inquiry source checkout error conversation if error console error error type error type console error reason error reason console error message error message return console log conversation id conversation id console log brand id conversation brandid console log full response conversation send message ze messenger sendmessage message object conversationid string callback function error response sends a message on behalf of the end user to an existing conversation parameters message object required the message to send property type required description content object yes the content of the message content type string yes must be text only text messages are supported content text string yes the message text must be a non empty non whitespace string metadata object no flat key value pairs of message level metadata string number or boolean conversationid string required the unique identifier of the conversation to send the message to callback function required the callback receives an error sendmessageerror null as the first parameter and a response as the second parameter when successful when an error occurs error is not null the error object object has the following structure type sendmessageerror error type identifier reason string one of invalid message invalid conversationid no user conversation not found message send failed message string a descriptive error message when successful error is null the response object object has the following structure id string null the unique identifier of the message receivedat number unix timestamp when the message was received examples send a simple text message ze messenger sendmessage content type text text hello i need help with my order 12345 error message if error console error sendmessage failed error return console log sent message id message id send a message with metadata ze messenger sendmessage content type text text hello i need help with my order metadata intent order_inquiry orderid 67890 source checkout 12345 error message if error console error error type error type console error reason error reason console error message error message return console log message id message id console log sent at new date message received console log full response message fetch conversations ze messenger fetchconversations offset number callback function error response retrieves a paginated list of conversations for the current user with up to 10 conversations per request parameters offset number required the starting index for pagination must be a non negative integer use 0 to fetch the first page callback function required the callback receives an error fetchconversationserror null as the first parameter and a response as the second parameter when successful when successful error is null the response object contains data array of conversation objects up to 10 per page id string the conversation id createdat number creation timestamp milliseconds or seconds lastupdatedat number last update timestamp displayname string null display name of the conversation or null if none iconurl string null icon url for the conversation or null if none status active idle conversation status type string conversation type identifier brandid string null associated brand id or null if none unreadcount number number of unread messages hasmore boolean whether there are more conversations available to fetch when an error occurs error is not null the error object contains type fetchconversationserror error type identifier reason string either invalid offset no user or failed to fetch conversations message string a descriptive error message example fetch first page of conversations ze messenger fetchconversations 0 error response if error console error failed to fetch conversations error reason return console log fetched conversations response data console log has more pages response hasmore fetch next page if available if response hasmore ze messenger fetchconversations 10 error nextresponse handle next page get config ze messenger get config callback function retrieves the current configuration state of the messaging web widget if the widget configuration hasn t loaded yet the callback is deferred until the configuration is received parameters callback function required the callback receives a config object when executed the config object object has the following structure canusercreatemoreconversations boolean whether the current user is permitted to create additional conversations multiconvoenabled boolean whether multi conversation mode is enabled for the widget launchershape string the shape of the widget launcher button square circle or none example ze messenger get config function config console log widget config config if config multiconvoenabled console log multi conversation mode is enabled if config launchershape none console log no launcher button using a custom launcher navigation ze messenger ui navigation config object navigates to a specific screen within the messaging web widget this api is only available in multi conversation mode and cannot be used in single conversation mode or embedded split view mode parameters config object required configuration specifying which screen to navigate to property type required description screen string yes one of conversationlist mostrecentactiveconversation conversation options object no only required for conversation screen contains conversationid when navigating to a specific conversation the options object has the following structure screen string one of conversationlist mostrecentactiveconversation conversation options optional only required for conversation screen conversationid string the id of the conversation to navigate to supported screens conversationlist navigates to the list of conversations mostrecentactiveconversation navigates to the most recent active conversation creates one if none exists conversation navigates to a specific conversation by id requires options conversationid examples navigate to conversation list ze messenge...