CINXE.COM

<!DOCTYPE html><html><head><meta name="viewport" content="width=device-width"/><meta charSet="utf-8"/><title>RTM pushes | Text Platform Docs & API Reference</title><link rel="canonical" href="https://platform.text.com/docs/messaging/agent-chat-api/rtm-pushes"/><link rel="preconnect" href="https://LATDYRDX9J-dsn.algolia.net" crossorigin="true"/><meta name="description" content="This document contains a reference of LiveChat RTM API pushes."/><meta property="og:title" content="RTM pushes"/><meta property="og:description" content="This document contains a reference of LiveChat RTM API pushes."/><meta property="og:type" content="website"/><meta property="og:image" content="https://platform.text.com/docs/images/text-docs-og.png"/><link rel="icon" href="/docs/images/favicon.ico"/><meta name="twitter:card" content="summary_large_image"/><meta name="twitter:creator" content="@textplatform"/><meta name="twitter:title" content="RTM pushes"/><meta name="twitter:description" content="This document contains a reference of LiveChat RTM API pushes."/><meta name="twitter:image" content="https://platform.text.com/docs/images/livechat-docs-og.png"/><script type="text/javascript"> window.__lc = window.__lc || {}; window.__lc.license = 1520; ;(function(n,t,c){function i(n){return e._h?e._h.apply(null,n):e._q.push(n)}var e={_q:[],_h:null,_v:"2.0",on:function(){i(["on",c.call(arguments)])},once:function(){i(["once",c.call(arguments)])},off:function(){i(["off",c.call(arguments)])},get:function(){if(!e._h)throw new Error("[LiveChatWidget] You can't use getters before load.");return i(["get",c.call(arguments)])},call:function(){i(["call",c.call(arguments)])},init:function(){var n=t.createElement("script");n.async=!0,n.type="text/javascript",n.src="https://cdn.livechatinc.com/staging/tracking.js",t.head.appendChild(n)}};!n.__lc.asyncInit&&e.init(),n.LiveChatWidget=n.LiveChatWidget||e}(window,document,[].slice)) </script><meta name="next-head-count" content="17"/><link rel="preload" href="/docs/_next/static/css/5c94b719b441ef6e576e.css" as="style"/><link rel="stylesheet" href="/docs/_next/static/css/5c94b719b441ef6e576e.css" data-n-g=""/><noscript data-n-css=""></noscript><link rel="preload" href="/docs/_next/static/chunks/webpack-af19fbe32e13fc779465.js" as="script"/><link rel="preload" href="/docs/_next/static/chunks/framework.57a22ac5870571c2eff5.js" as="script"/><link rel="preload" href="/docs/_next/static/chunks/commons.0889bf71124535c6c4cd.js" as="script"/><link rel="preload" href="/docs/_next/static/chunks/main-7bb61c4f8d40f1e634e9.js" as="script"/><link rel="preload" href="/docs/_next/static/chunks/pages/_app-cdbe91fdfdbd305577ef.js" as="script"/><link rel="preload" href="/docs/_next/static/chunks/f66b9295.f9eceaafe4216b86326e.js" as="script"/><link rel="preload" href="/docs/_next/static/chunks/b31dc3a52fd33fe1943f491eae223576a0413e10.ac30430b2138b8fefed8.js" as="script"/><link rel="preload" href="/docs/_next/static/chunks/067aff065064306958fa97cea949633bebf95d70.dede6f8249fbb82aff52.js" as="script"/><link rel="preload" href="/docs/_next/static/chunks/pages/messaging/agent-chat-api/rtm-pushes-441c73352c99984f65cc.js" as="script"/> <script>!function(e){var n="https://s.go-mpulse.net/boomerang/";if("False"=="True")e.BOOMR_config=e.BOOMR_config||{},e.BOOMR_config.PageParams=e.BOOMR_config.PageParams||{},e.BOOMR_config.PageParams.pci=!0,n="https://s2.go-mpulse.net/boomerang/";if(window.BOOMR_API_key="SWHJY-Y2PHV-NVPM2-PDH42-VMPQS",function(){function e(){if(!o){var e=document.createElement("script");e.id="boomr-scr-as",e.src=window.BOOMR.url,e.async=!0,i.parentNode.appendChild(e),o=!0}}function t(e){o=!0;var n,t,a,r,d=document,O=window;if(window.BOOMR.snippetMethod=e?"if":"i",t=function(e,n){var t=d.createElement("script");t.id=n||"boomr-if-as",t.src=window.BOOMR.url,BOOMR_lstart=(new Date).getTime(),e=e||d.body,e.appendChild(t)},!window.addEventListener&&window.attachEvent&&navigator.userAgent.match(/MSIE [67]\./))return window.BOOMR.snippetMethod="s",void t(i.parentNode,"boomr-async");a=document.createElement("IFRAME"),a.src="about:blank",a.title="",a.role="presentation",a.loading="eager",r=(a.frameElement||a).style,r.width=0,r.height=0,r.border=0,r.display="none",i.parentNode.appendChild(a);try{O=a.contentWindow,d=O.document.open()}catch(_){n=document.domain,a.src="javascript:var d=document.open();d.domain='"+n+"';void(0);",O=a.contentWindow,d=O.document.open()}if(n)d._boomrl=function(){this.domain=n,t()},d.write("<bo"+"dy onload='document._boomrl();'>");else if(O._boomrl=function(){t()},O.addEventListener)O.addEventListener("load",O._boomrl,!1);else if(O.attachEvent)O.attachEvent("onload",O._boomrl);d.close()}function a(e){window.BOOMR_onload=e&&e.timeStamp||(new Date).getTime()}if(!window.BOOMR||!window.BOOMR.version&&!window.BOOMR.snippetExecuted){window.BOOMR=window.BOOMR||{},window.BOOMR.snippetStart=(new Date).getTime(),window.BOOMR.snippetExecuted=!0,window.BOOMR.snippetVersion=12,window.BOOMR.url=n+"SWHJY-Y2PHV-NVPM2-PDH42-VMPQS";var i=document.currentScript||document.getElementsByTagName("script")[0],o=!1,r=document.createElement("link");if(r.relList&&"function"==typeof r.relList.supports&&r.relList.supports("preload")&&"as"in r)window.BOOMR.snippetMethod="p",r.href=window.BOOMR.url,r.rel="preload",r.as="script",r.addEventListener("load",e),r.addEventListener("error",function(){t(!0)}),setTimeout(function(){if(!o)t(!0)},3e3),BOOMR_lstart=(new Date).getTime(),i.parentNode.appendChild(r);else t(!1);if(window.addEventListener)window.addEventListener("load",a,!1);else if(window.attachEvent)window.attachEvent("onload",a)}}(),"".length>0)if(e&&"performance"in e&&e.performance&&"function"==typeof e.performance.setResourceTimingBufferSize)e.performance.setResourceTimingBufferSize();!function(){if(BOOMR=e.BOOMR||{},BOOMR.plugins=BOOMR.plugins||{},!BOOMR.plugins.AK){var n=""=="true"?1:0,t="",a="bdpnbet4tppcaz2gzuya-f-29cd7dbb9-clientnsv4-s.akamaihd.net",i="false"=="true"?2:1,o={"ak.v":"39","ak.cp":"1461330","ak.ai":parseInt("908031",10),"ak.ol":"0","ak.cr":1,"ak.ipv":4,"ak.proto":"http/1.1","ak.rid":"13b6f9b1","ak.r":6099,"ak.a2":n,"ak.m":"b","ak.n":"essl","ak.bpcip":"8.222.208.0","ak.cport":43076,"ak.gh":"124.155.222.130","ak.quicv":"","ak.tlsv":"tls1.2","ak.0rtt":"","ak.0rtt.ed":"","ak.csrc":"-","ak.acc":"bbr","ak.t":"1732693296","ak.ak":"hOBiQwZUYzCg5VSAfCLimQ==F1c0Qtzc7TM6FadexRE+3tareYMwh8AJRIkbGo3YnVDWrijyk7hP6dAOFC8pUNx5SZT7JyO0mj9lwT3sZY5aklYgIllpKommGOnX747GOvO2P4ytVovayndzLYCH51kzoIwHyzwW0FCz8V+32rCB1Vwgkx451k6uKj7iLBzCbod2/BxN+8Th4wT/wH019Z1J06prMCxwgI20Mg1bZedFCnuTzwXbo20z+dG7AA49MoEgP5mbV4/WbROn4JYSLuii214KNO9QXCFqsAgxMifZ4ALiIZP7dgjAD21A89FPo9mGZ5J/qp3iY6/qiDb7BBvYmVTN8UU3XQ6SkF1pZxxygeuulkqv9eS0OaRjcJ0YyEbpxlBWktvwk/mPOSL0ehdj22nLHDM17SVhgB1onHXUTpT3pCKmEm5tfPPjFQOj6zk=","ak.pv":"55","ak.dpoabenc":"","ak.tf":i};if(""!==t)o["ak.ruds"]=t;var r={i:!1,av:function(n){var t="http.initiator";if(n&&(!n[t]||"spa_hard"===n[t]))o["ak.feo"]=void 0!==e.aFeoApplied?1:0,BOOMR.addVar(o)},rv:function(){var e=["ak.bpcip","ak.cport","ak.cr","ak.csrc","ak.gh","ak.ipv","ak.m","ak.n","ak.ol","ak.proto","ak.quicv","ak.tlsv","ak.0rtt","ak.0rtt.ed","ak.r","ak.acc","ak.t","ak.tf"];BOOMR.removeVar(e)}};BOOMR.plugins.AK={akVars:o,akDNSPreFetchDomain:a,init:function(){if(!r.i){var e=BOOMR.subscribe;e("before_beacon",r.av,null,null),e("onbeacon",r.rv,null,null),r.i=!0}return this},is_complete:function(){return!0}}}}()}(window);</script></head><body><div id="__next"><style data-emotion-css="cvn8wj">.css-cvn8wj{font-family:Colfax,colfax-web,Proxima Nova,Open Sans,Gill Sans MT, Gill Sans,Corbel,Arial,sans-serif;background-color:#4a4a55;height:60px;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;-webkit-flex-direction:column;-ms-flex-direction:column;flex-direction:column;position:fixed;top:0;width:100%;z-index:99;}@media (min-width:768px){.css-cvn8wj{height:60px;}}</style><div class="css-cvn8wj"><style data-emotion-css="y9662z">.css-y9662z{background:#4a4a55;width:100%;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-box-pack:justify;-webkit-justify-content:space-between;-ms-flex-pack:justify;justify-content:space-between;}</style><div class="css-y9662z"><style data-emotion-css="qqcdow">.css-qqcdow{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;font-size:15px;margin:0 20px;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;height:60px;}.css-qqcdow > a > svg{margin:0;display:block;height:24px;}</style><nav class="css-qqcdow"><style data-emotion-css="c2yzgf">.css-c2yzgf{color:white;-webkit-text-decoration:none;text-decoration:none;font-weight:500;white-space:nowrap;margin-left:8px;}.css-c2yzgf:hover{-webkit-text-decoration:none;text-decoration:none;color:white;}</style><a href="https://text.com/" class="css-c2yzgf"><style data-emotion-css="ofqsza">.css-ofqsza{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;justify-items:center;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;gap:0.8em;height:40px;}.css-ofqsza .logo{margin:0;font-size:2em;font-weight:500;-webkit-letter-spacing:-0.01em;-moz-letter-spacing:-0.01em;-ms-letter-spacing:-0.01em;letter-spacing:-0.01em;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;}.css-ofqsza .adjacent{margin:0;font-size:1.8em;font-weight:500;line-height:34px;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;-webkit-letter-spacing:-0.5px;-moz-letter-spacing:-0.5px;-ms-letter-spacing:-0.5px;letter-spacing:-0.5px;}.css-ofqsza .carrier{font-weight:500;-webkit-animation-name:blink;animation-name:blink;-webkit-animation-duration:0.9s;animation-duration:0.9s;-webkit-animation-iteration-count:infinite;animation-iteration-count:infinite;}</style><header class="css-ofqsza"><span class="logo">text<span class="carrier">|</span></span></header></a><a href="/docs" class="css-c2yzgf">Platform Docs</a></nav><style data-emotion-css="16b59id">.css-16b59id{margin:0;padding:0;max-width:calc(100% - 60px);width:calc(100% - 60px);overflow-x:auto;overflow-y:hidden;display:none;margin-right:10px;margin-left:40px;}@media (min-width:1024px){.css-16b59id{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;gap:32px;}}</style><div class="css-16b59id"><style data-emotion-css="11hjr56">.css-11hjr56{font-family:Colfax,colfax-web,Proxima Nova,Open Sans,Gill Sans MT, Gill Sans,Corbel,Arial,sans-serif;position:relative;display:inline-block;height:100%;color:#ffffff;font-weight:400;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;}.css-11hjr56:hover{cursor:default;}</style><div class="css-11hjr56">Platform<svg width="24" height="24" fill="#FFFFFF" class="rmi rmi-chevron-down undefined" viewBox="0 0 24 24"><path d="M7.41 8.58 12 13.17l4.59-4.59L18 10l-6 6-6-6 1.41-1.42z"></path></svg></div><div class="css-11hjr56">APIs & SDKs<svg width="24" height="24" fill="#FFFFFF" class="rmi rmi-chevron-down undefined" viewBox="0 0 24 24"><path d="M7.41 8.58 12 13.17l4.59-4.59L18 10l-6 6-6-6 1.41-1.42z"></path></svg></div><div class="css-11hjr56">Resources<svg width="24" height="24" fill="#FFFFFF" class="rmi rmi-chevron-down undefined" viewBox="0 0 24 24"><path d="M7.41 8.58 12 13.17l4.59-4.59L18 10l-6 6-6-6 1.41-1.42z"></path></svg></div></div><style data-emotion-css="1hppjzv">.css-1hppjzv{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-box-pack:center;-webkit-justify-content:center;-ms-flex-pack:center;justify-content:center;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;}</style><div class="css-1hppjzv"><style data-emotion-css="7wgbw1">.css-7wgbw1{display:none;}@media (min-width:1024px){.css-7wgbw1{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;width:192px;margin-right:16px;}}</style><div class="DocSearch-Button-Desktop css-7wgbw1"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div><style data-emotion-css="1i8rrts">.css-1i8rrts{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-box-pack:center;-webkit-justify-content:center;-ms-flex-pack:center;justify-content:center;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;height:100%;}@media (min-width:1024px){.css-1i8rrts{display:none;}}</style><div class="DocSearch-Button-Mobile css-1i8rrts"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div><p>...</p><style data-emotion-css="pskeb7">@media (min-width:1024px){.css-pskeb7{display:none;}}</style><style data-emotion-css="19rp0xe">.css-19rp0xe{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;margin-right:16px;cursor:pointer;}@media (min-width:1024px){.css-19rp0xe{display:none;}}@media (min-width:1024px){.css-19rp0xe{display:none;}}</style><svg width="32px" height="28px" fill="#ffffff" class="rmi rmi-menu css-19rp0xe" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"></path></svg></div></div></div><style data-emotion-css="ov1ktg">.css-ov1ktg{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;}</style><div class="css-ov1ktg"><style data-emotion-css="hpx2k5">.css-hpx2k5{border-right:1px solid #e2e2e4;height:50px;position:fixed;-webkit-transition:height 300ms;transition:height 300ms;display:block;bottom:0%;width:100%;opacity:1;z-index:10;box-shadow:0px 0px 8px rgba(0,0,0,0.25);background-color:white;}@media (min-width:768px){.css-hpx2k5{box-shadow:none;height:100vh;max-height:100vh;position:-webkit-sticky;position:sticky;top:60px;-webkit-transition:all 0s;transition:all 0s;width:260px;}}</style><aside class="css-hpx2k5"><style data-emotion-css="y8dejn">.css-y8dejn{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;background-color:white;padding:10px 14px;cursor:pointer;}@media (min-width:768px){.css-y8dejn{display:none;}}</style><div class="css-y8dejn"><svg style="transform:rotate(270deg);transition:transform 300ms" xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24"><path d="M10 6L8.59 7.41 13.17 12l-4.58 4.59L10 18l6-6z" fill="currentColor"></path><path d="M0 0h24v24H0z" fill="none"></path></svg>RTM pushes</div><style data-emotion-css="v8mm6">.css-v8mm6{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;}@media (min-width:768px){.css-v8mm6{display:none;}}</style><div class="css-v8mm6"><style data-emotion-css="1pjh3pd">.css-1pjh3pd{width:100%;color:#62626D;}.css-1pjh3pd:hover{cursor:pointer;-webkit-text-decoration:none;text-decoration:none;background-color:#f6f6f7;}</style><a class="css-1pjh3pd"><style data-emotion-css="1yw2pv4">.css-1yw2pv4{padding:4px 14px;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;font-size:16px;}</style><div class="css-1yw2pv4"><style data-emotion-css="5c7uuc">.css-5c7uuc{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;-webkit-box-pack:start;-webkit-justify-content:start;-ms-flex-pack:start;justify-content:start;}</style><div class="css-5c7uuc"><svg width="24" height="20px" fill="#62626D" class="rmi rmi-home undefined" viewBox="0 0 24 24"><path d="M10 20v-6h4v6h5v-8h3L12 3 2 12h3v8h5z"></path></svg></div>Home</div></a></div><style data-emotion-css="1ln71vl">.css-1ln71vl{overflow:scroll;height:calc(100% - 90px);}@media (min-width:768px){.css-1ln71vl{height:calc(100% - 60px);position:fixed;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-flex-direction:column;-ms-flex-direction:column;flex-direction:column;height:100%;max-height:100vh;position:-webkit-sticky;position:-webkit-sticky;position:sticky;top:0;margin-top:8px;}}</style><div class="css-1ln71vl"><style data-emotion-css="1psvkz3">.css-1psvkz3{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;-webkit-box-pack:justify;-webkit-justify-content:space-between;-ms-flex-pack:justify;justify-content:space-between;margin-right:10px;font-weight:500;font-size:16px;border-radius:0px 8px 8px 0px;}.css-1psvkz3:hover{background-color:#f6f6f7;}</style><div class="css-1psvkz3"><style data-emotion-css="19nl305">.css-19nl305{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;color:#62626D;width:100%;}.css-19nl305:hover{color:#4284F5;cursor:pointer;-webkit-text-decoration:none;text-decoration:none;}</style><a class="css-19nl305"><style data-emotion-css="2hhlpj">.css-2hhlpj{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;padding:6px 16px 6px 20px;margin-right:10px;font-weight:500;font-size:16px;border-radius:0px 8px 8px 0px;width:100%;}.css-2hhlpj:hover{background-color:#f6f6f7;}</style><div class="css-2hhlpj"><style data-emotion-css="oe3dsw">.css-oe3dsw{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;margin-right:8px;}</style><div class="css-oe3dsw"><svg fill="#ABABB1" width="12px" height="16px" viewBox="0 0 12 16" version="1.1" xmlns="http://www.w3.org/2000/svg" xlink="http://www.w3.org/1999/xlink"><path d="M1.5,0.5 C0.675,0.5 0.0075,1.175 0.0075,2 L0,14 C0,14.825 0.6675,15.5 1.4925,15.5 L10.5,15.5 C11.325,15.5 12,14.825 12,14 L12,5 L7.5,0.5 L1.5,0.5 Z M6.75,5.75 L6.75,1.625 L10.875,5.75 L6.75,5.75 Z" fill-rule="nonzero" fill="currentColor"></path></svg></div>Messaging Overview</div></a></div><div class="css-1psvkz3"><a class="css-19nl305"><div class="css-2hhlpj"><div class="css-oe3dsw"><svg fill="#ABABB1" width="12px" height="16px" viewBox="0 0 12 16" version="1.1" xmlns="http://www.w3.org/2000/svg" xlink="http://www.w3.org/1999/xlink"><path d="M1.5,0.5 C0.675,0.5 0.0075,1.175 0.0075,2 L0,14 C0,14.825 0.6675,15.5 1.4925,15.5 L10.5,15.5 C11.325,15.5 12,14.825 12,14 L12,5 L7.5,0.5 L1.5,0.5 Z M6.75,5.75 L6.75,1.625 L10.875,5.75 L6.75,5.75 Z" fill-rule="nonzero" fill="currentColor"></path></svg></div>Agent Chat API</div></a><style data-emotion-css="5opgc4">.css-5opgc4{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;-webkit-box-pack:center;-webkit-justify-content:center;-ms-flex-pack:center;justify-content:center;padding-right:5px;-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg);-webkit-transition:-webkit-transform 300ms;-webkit-transition:transform 300ms;transition:transform 300ms;cursor:pointer;}</style><div class="css-5opgc4"><svg width="24" height="24px" fill="#62626D" weight="24px" class="rmi rmi-chevron-right undefined" viewBox="0 0 24 24"><path d="M8.59 16.58 13.17 12 8.59 7.41 10 6l6 6-6 6-1.41-1.42z"></path></svg></div></div><a class="css-19nl305"><style data-emotion-css="1hg01uv">.css-1hg01uv{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;padding:6px 16px 6px 30px;margin-right:10px;font-weight:500;font-size:16px;border-radius:0px 8px 8px 0px;width:100%;}.css-1hg01uv:hover{background-color:#f6f6f7;}</style><div class="css-1hg01uv"><div class="css-oe3dsw"><svg fill="#ABABB1" width="12px" height="16px" viewBox="0 0 12 16" version="1.1" xmlns="http://www.w3.org/2000/svg" xlink="http://www.w3.org/1999/xlink"><path d="M1.5,0.5 C0.675,0.5 0.0075,1.175 0.0075,2 L0,14 C0,14.825 0.6675,15.5 1.4925,15.5 L10.5,15.5 C11.325,15.5 12,14.825 12,14 L12,5 L7.5,0.5 L1.5,0.5 Z M6.75,5.75 L6.75,1.625 L10.875,5.75 L6.75,5.75 Z" fill-rule="nonzero" fill="currentColor"></path></svg></div>Web API Reference</div></a><a class="css-19nl305"><div class="css-1hg01uv"><div class="css-oe3dsw"><svg fill="#ABABB1" width="12px" height="16px" viewBox="0 0 12 16" version="1.1" xmlns="http://www.w3.org/2000/svg" xlink="http://www.w3.org/1999/xlink"><path d="M1.5,0.5 C0.675,0.5 0.0075,1.175 0.0075,2 L0,14 C0,14.825 0.6675,15.5 1.4925,15.5 L10.5,15.5 C11.325,15.5 12,14.825 12,14 L12,5 L7.5,0.5 L1.5,0.5 Z M6.75,5.75 L6.75,1.625 L10.875,5.75 L6.75,5.75 Z" fill-rule="nonzero" fill="currentColor"></path></svg></div>RTM API Reference</div></a><a class="css-19nl305"><div class="css-1hg01uv"><div class="css-oe3dsw"><svg fill="#ABABB1" width="12px" height="16px" viewBox="0 0 12 16" version="1.1" xmlns="http://www.w3.org/2000/svg" xlink="http://www.w3.org/1999/xlink"><path d="M1.5,0.5 C0.675,0.5 0.0075,1.175 0.0075,2 L0,14 C0,14.825 0.6675,15.5 1.4925,15.5 L10.5,15.5 C11.325,15.5 12,14.825 12,14 L12,5 L7.5,0.5 L1.5,0.5 Z M6.75,5.75 L6.75,1.625 L10.875,5.75 L6.75,5.75 Z" fill-rule="nonzero" fill="currentColor"></path></svg></div>Data structures</div></a><style data-emotion-css="17iyluq">.css-17iyluq{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;color:#4284F5;width:100%;}.css-17iyluq:hover{color:#4284F5;cursor:pointer;-webkit-text-decoration:none;text-decoration:none;}</style><a class="css-17iyluq"><style data-emotion-css="yqezgo">.css-yqezgo{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;padding:6px 16px 6px 30px;margin-right:10px;font-weight:600;font-size:16px;border-radius:0px 8px 8px 0px;width:100%;}.css-yqezgo:hover{background-color:#f6f6f7;}</style><div class="css-yqezgo"><div class="css-oe3dsw"><svg fill="#ABABB1" width="12px" height="16px" viewBox="0 0 12 16" version="1.1" xmlns="http://www.w3.org/2000/svg" xlink="http://www.w3.org/1999/xlink"><path d="M1.5,0.5 C0.675,0.5 0.0075,1.175 0.0075,2 L0,14 C0,14.825 0.6675,15.5 1.4925,15.5 L10.5,15.5 C11.325,15.5 12,14.825 12,14 L12,5 L7.5,0.5 L1.5,0.5 Z M6.75,5.75 L6.75,1.625 L10.875,5.75 L6.75,5.75 Z" fill-rule="nonzero" fill="currentColor"></path></svg></div>RTM pushes</div></a><a class="css-19nl305"><div class="css-1hg01uv"><div class="css-oe3dsw"><svg fill="#ABABB1" width="12px" height="16px" viewBox="0 0 12 16" version="1.1" xmlns="http://www.w3.org/2000/svg" xlink="http://www.w3.org/1999/xlink"><path d="M1.5,0.5 C0.675,0.5 0.0075,1.175 0.0075,2 L0,14 C0,14.825 0.6675,15.5 1.4925,15.5 L10.5,15.5 C11.325,15.5 12,14.825 12,14 L12,5 L7.5,0.5 L1.5,0.5 Z M6.75,5.75 L6.75,1.625 L10.875,5.75 L6.75,5.75 Z" fill-rule="nonzero" fill="currentColor"></path></svg></div>Changelog</div></a><div class="css-1psvkz3"><a class="css-19nl305"><div class="css-2hhlpj"><div class="css-oe3dsw"><svg fill="#ABABB1" width="12px" height="16px" viewBox="0 0 12 16" version="1.1" xmlns="http://www.w3.org/2000/svg" xlink="http://www.w3.org/1999/xlink"><path d="M1.5,0.5 C0.675,0.5 0.0075,1.175 0.0075,2 L0,14 C0,14.825 0.6675,15.5 1.4925,15.5 L10.5,15.5 C11.325,15.5 12,14.825 12,14 L12,5 L7.5,0.5 L1.5,0.5 Z M6.75,5.75 L6.75,1.625 L10.875,5.75 L6.75,5.75 Z" fill-rule="nonzero" fill="currentColor"></path></svg></div>Customer Chat API</div></a><style data-emotion-css="155ms1k">.css-155ms1k{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;-webkit-box-pack:center;-webkit-justify-content:center;-ms-flex-pack:center;justify-content:center;padding-right:5px;-webkit-transform:rotate(0deg);-ms-transform:rotate(0deg);transform:rotate(0deg);-webkit-transition:-webkit-transform 300ms;-webkit-transition:transform 300ms;transition:transform 300ms;cursor:pointer;}</style><div class="css-155ms1k"><svg width="24" height="24px" fill="#62626D" weight="24px" class="rmi rmi-chevron-right undefined" viewBox="0 0 24 24"><path d="M8.59 16.58 13.17 12 8.59 7.41 10 6l6 6-6 6-1.41-1.42z"></path></svg></div></div><div class="css-1psvkz3"><a class="css-19nl305"><div class="css-2hhlpj"><div class="css-oe3dsw"><svg fill="#ABABB1" width="12px" height="16px" viewBox="0 0 12 16" version="1.1" xmlns="http://www.w3.org/2000/svg" xlink="http://www.w3.org/1999/xlink"><path d="M1.5,0.5 C0.675,0.5 0.0075,1.175 0.0075,2 L0,14 C0,14.825 0.6675,15.5 1.4925,15.5 L10.5,15.5 C11.325,15.5 12,14.825 12,14 L12,5 L7.5,0.5 L1.5,0.5 Z M6.75,5.75 L6.75,1.625 L10.875,5.75 L6.75,5.75 Z" fill-rule="nonzero" fill="currentColor"></path></svg></div>LiveChat Node.js SDK</div></a></div><div class="css-1psvkz3"><a class="css-19nl305"><div class="css-2hhlpj"><div class="css-oe3dsw"><svg fill="#ABABB1" width="12px" height="16px" viewBox="0 0 12 16" version="1.1" xmlns="http://www.w3.org/2000/svg" xlink="http://www.w3.org/1999/xlink"><path d="M1.5,0.5 C0.675,0.5 0.0075,1.175 0.0075,2 L0,14 C0,14.825 0.6675,15.5 1.4925,15.5 L10.5,15.5 C11.325,15.5 12,14.825 12,14 L12,5 L7.5,0.5 L1.5,0.5 Z M6.75,5.75 L6.75,1.625 L10.875,5.75 L6.75,5.75 Z" fill-rule="nonzero" fill="currentColor"></path></svg></div>LiveChat Go SDK</div></a></div><div class="css-1psvkz3"><a class="css-19nl305"><div class="css-2hhlpj"><div class="css-oe3dsw"><svg fill="#ABABB1" width="12px" height="16px" viewBox="0 0 12 16" version="1.1" xmlns="http://www.w3.org/2000/svg" xlink="http://www.w3.org/1999/xlink"><path d="M1.5,0.5 C0.675,0.5 0.0075,1.175 0.0075,2 L0,14 C0,14.825 0.6675,15.5 1.4925,15.5 L10.5,15.5 C11.325,15.5 12,14.825 12,14 L12,5 L7.5,0.5 L1.5,0.5 Z M6.75,5.75 L6.75,1.625 L10.875,5.75 L6.75,5.75 Z" fill-rule="nonzero" fill="currentColor"></path></svg></div>LiveChat JS SDK</div></a></div><div class="css-1psvkz3"><a class="css-19nl305"><div class="css-2hhlpj"><div class="css-oe3dsw"><svg fill="#ABABB1" width="12px" height="16px" viewBox="0 0 12 16" version="1.1" xmlns="http://www.w3.org/2000/svg" xlink="http://www.w3.org/1999/xlink"><path d="M1.5,0.5 C0.675,0.5 0.0075,1.175 0.0075,2 L0,14 C0,14.825 0.6675,15.5 1.4925,15.5 L10.5,15.5 C11.325,15.5 12,14.825 12,14 L12,5 L7.5,0.5 L1.5,0.5 Z M6.75,5.75 L6.75,1.625 L10.875,5.75 L6.75,5.75 Z" fill-rule="nonzero" fill="currentColor"></path></svg></div>LiveChat Python SDK</div></a></div><div class="css-1psvkz3"><a class="css-19nl305"><div class="css-2hhlpj"><div class="css-oe3dsw"><svg fill="#ABABB1" width="12px" height="16px" viewBox="0 0 12 16" version="1.1" xmlns="http://www.w3.org/2000/svg" xlink="http://www.w3.org/1999/xlink"><path d="M1.5,0.5 C0.675,0.5 0.0075,1.175 0.0075,2 L0,14 C0,14.825 0.6675,15.5 1.4925,15.5 L10.5,15.5 C11.325,15.5 12,14.825 12,14 L12,5 L7.5,0.5 L1.5,0.5 Z M6.75,5.75 L6.75,1.625 L10.875,5.75 L6.75,5.75 Z" fill-rule="nonzero" fill="currentColor"></path></svg></div>References</div></a><div class="css-155ms1k"><svg width="24" height="24px" fill="#62626D" weight="24px" class="rmi rmi-chevron-right undefined" viewBox="0 0 24 24"><path d="M8.59 16.58 13.17 12 8.59 7.41 10 6l6 6-6 6-1.41-1.42z"></path></svg></div></div></div></aside><style data-emotion-css="1g06r20">.css-1g06r20{padding-bottom:30vh;position:relative;width:100%;}@media (min-width:768px){.css-1g06r20{width:calc(100% - 258px);max-width:900px;}}</style><div class="css-1g06r20"><style data-emotion-css="yofbie">.css-yofbie{width:100%;position:fixed;top:60px;right:0;z-index:40;-webkit-transition:left 0.3s ease-out;transition:left 0.3s ease-out;}@media (min-width:768px){.css-yofbie{left:260px;width:calc(100% - 260px);top:60px;}}</style><div class="css-yofbie"><style data-emotion-css="9hc061">.css-9hc061{padding:20px 24px 32px 60px;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-flex-direction:row;-ms-flex-direction:row;flex-direction:row;-webkit-box-pack:end;-webkit-justify-content:flex-end;-ms-flex-pack:end;justify-content:flex-end;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;gap:10px;}@media (max-width:1270px){.css-9hc061{background-color:#fff;padding-bottom:24px;}}@media (max-width:768px){.css-9hc061{-webkit-box-pack:start;-webkit-justify-content:flex-start;-ms-flex-pack:start;justify-content:flex-start;padding-left:30px;}}</style><div class="css-9hc061"><style data-emotion-css="7fagxn">.css-7fagxn{font-weight:400;font-size:15px;line-height:22px;padding:7px 8px 7px 16px;}</style><button class="lc-btn lc-btn--secondary css-7fagxn" type="button"><div><style data-emotion-css="44gx6g">.css-44gx6g{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;gap:4px;}</style><div class="css-44gx6g"><span>API version:</span><span>3.5 (stable)</span><svg width="20px" height="20px" fill="#424D57" class="rmi rmi-chevron-down undefined" viewBox="0 0 24 24"><path d="M7.41 8.58 12 13.17l4.59-4.59L18 10l-6 6-6-6 1.41-1.42z"></path></svg></div></div></button></div></div><style data-emotion-css="c8i9h7">.css-c8i9h7{margin-top:120px;padding:0px 30px;}@media (min-width:768px){.css-c8i9h7{padding:0px 60px;}}.css-c8i9h7.redoc{margin-top:60px;display:block;}</style><article class=" css-c8i9h7"><style data-emotion-css="1lyzzun">.css-1lyzzun{margin:3em 0 1em;padding:2em 0 1em;}</style><div class="css-1lyzzun"><style data-emotion-css="12qxxrf">.css-12qxxrf{margin:0;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-box-pack:justify;-webkit-justify-content:space-between;-ms-flex-pack:justify;justify-content:space-between;-webkit-flex-direction:column;-ms-flex-direction:column;flex-direction:column;font-weight:500;text-rendering:optimizeLegibility;font-size:2.25rem;line-height:1.1;-webkit-letter-spacing:-0.02em;-moz-letter-spacing:-0.02em;-ms-letter-spacing:-0.02em;letter-spacing:-0.02em;}@media (min-width:768px){.css-12qxxrf{-webkit-flex-direction:row;-ms-flex-direction:row;flex-direction:row;}}</style><h2 id="rtm-pushes" class="css-12qxxrf"><span>RTM pushes</span><style data-emotion-css="1g0dr3m">.css-1g0dr3m{margin-top:8px;}.css-1g0dr3m > label{margin:0 0 5px 0;}.css-1g0dr3m label + div{-webkit-box-pack:end;-webkit-justify-content:flex-end;-ms-flex-pack:end;justify-content:flex-end;}</style></h2></div><p>This document contains a reference of <strong>pushes</strong> available in the <strong>LiveChat Agent Chat API</strong>. Similarly to <a href="/docs/management/webhooks">webhooks</a>, pushes notify you when specific events occur. They're usually generated as result of RTM API actions, but it's also possible to receive them in result of Web API actions.</p><style data-emotion-css="v24v0q">.css-v24v0q{max-width:830px;}</style><section class="css-v24v0q"><style data-emotion-css="11ycufd">.css-11ycufd{-webkit-box-flex:2;-webkit-flex-grow:2;-ms-flex-positive:2;flex-grow:2;max-width:100%;overflow-x:auto;}</style><div class="css-11ycufd"><h3 class="heading"><style data-emotion-css="180507a">.css-180507a{color:inherit;-webkit-text-decoration:none;text-decoration:none;position:relative;}.css-180507a:hover{color:inherit;-webkit-text-decoration:none;text-decoration:none;}.css-180507a:hover:before{content:"#";position:absolute;font-weight:300;left:-1em;top:1px;opacity:0.3;}.css-180507a:focus-visible{outline-width:0px;}</style><a id="introduction" href="#introduction" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#introduction"><span class="icon icon-link"></span></a>Introduction</a></h3><p>Here's what you need to know about <strong>pushes</strong>:</p><ul><li>They are generated primarily by RTM API actions, but also by Web API actions.</li><li>They notify you when specific events occur.</li><li>Can be <strong>delivered</strong> only in the websocket transport.</li><li>You don't need to register pushes to receive them.</li><li>Their equivalents in Web API are <a href="/docs/management/configuration-api/v3.5#webhooks">webhooks</a>. Pushes and webhooks have similar payloads.</li><li>There are no retries for pushes. To determine if a user has seen an event, compare the <a href="/docs/messaging/agent-chat-api/v3.5/data-structures#response">event's</a> <code>created_at</code> parameter with the <a href="/docs/messaging/agent-chat-api/v3.5/data-structures#users">user's</a> <code>events_seen_up_to</code> field.</li></ul><h3 class="heading"><a id="available-pushes" href="#available-pushes" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#available-pushes"><span class="icon icon-link"></span></a>Available pushes</a></h3><style data-emotion-css="q76ucn">.css-q76ucn{width:100%;overflow-x:auto;}</style><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><strong>Chats</strong></td><td><style data-emotion-css="kbi7q3">.css-kbi7q3{-webkit-text-decoration:none;text-decoration:none;}.css-kbi7q3 svg{vertical-align:middle;margin-left:2px;margin-right:4px;color:#4284F5;}.css-kbi7q3 code{color:#4284F5;}.css-kbi7q3:hover,.css-kbi7q3:active{-webkit-text-decoration:none;text-decoration:none;}.css-kbi7q3:hover code,.css-kbi7q3:active code{color:#4284F5;-webkit-text-decoration:underline;text-decoration:underline;}</style><a href="/docs/messaging/agent-chat-api/rtm-pushes#incoming_chat" class="css-kbi7q3"><code>incoming_chat</code></a> <a href="/docs/messaging/agent-chat-api/rtm-pushes#chat_deactivated" class="css-kbi7q3"><code>chat_deactivated</code></a> <a href="/docs/messaging/agent-chat-api/rtm-pushes#chat_deleted" class="css-kbi7q3"><code>chat_deleted</code></a> <a href="/docs/messaging/agent-chat-api/rtm-pushes#thread_deleted" class="css-kbi7q3"><code>thread_deleted</code></a> <a href="/docs/messaging/agent-chat-api/rtm-pushes#threads_deleted" class="css-kbi7q3"><code>threads_deleted</code></a></td></tr><tr><td><strong>Chat access</strong></td><td><a href="/docs/messaging/agent-chat-api/rtm-pushes#chat_access_updated" class="css-kbi7q3"><code>chat_access_updated</code></a> <a href="/docs/messaging/agent-chat-api/rtm-pushes#chat_transferred" class="css-kbi7q3"><code>chat_transferred</code></a></td></tr><tr><td><strong>Chat users</strong></td><td><a href="/docs/messaging/agent-chat-api/rtm-pushes#user_added_to_chat" class="css-kbi7q3"><code>user_added_to_chat</code></a> <a href="/docs/messaging/agent-chat-api/rtm-pushes#user_removed_from_chat" class="css-kbi7q3"><code>user_removed_from_chat</code></a></td></tr><tr><td><strong>Events</strong></td><td><a href="/docs/messaging/agent-chat-api/rtm-pushes#incoming_event" class="css-kbi7q3"><code>incoming_event</code></a> <a href="/docs/messaging/agent-chat-api/rtm-pushes#event_updated" class="css-kbi7q3"><code>event_updated</code></a><a href="/docs/messaging/agent-chat-api/rtm-pushes#incoming_rich_message_postback" class="css-kbi7q3"><code>incoming_rich_message_postback</code></a></td></tr><tr><td><strong>Properties</strong></td><td><a href="/docs/messaging/agent-chat-api/rtm-pushes#chat_properties_updated" class="css-kbi7q3"><code>chat_properties_updated</code></a> <a href="/docs/messaging/agent-chat-api/rtm-pushes#chat_properties_deleted" class="css-kbi7q3"><code>chat_properties_deleted</code></a> <a href="/docs/messaging/agent-chat-api/rtm-pushes#thread_properties_updated" class="css-kbi7q3"><code>thread_properties_updated</code></a> <a href="/docs/messaging/agent-chat-api/rtm-pushes#thread_properties_deleted" class="css-kbi7q3"><code>thread_properties_deleted</code></a> <a href="/docs/messaging/agent-chat-api/rtm-pushes#event_properties_updated" class="css-kbi7q3"><code>event_properties_updated</code></a> <a href="/docs/messaging/agent-chat-api/rtm-pushes#event_properties_deleted" class="css-kbi7q3"><code>event_properties_deleted</code></a></td></tr><tr><td><strong>Thread tags</strong></td><td><a href="/docs/messaging/agent-chat-api/rtm-pushes#thread_tagged" class="css-kbi7q3"><code>thread_tagged</code></a> <a href="/docs/messaging/agent-chat-api/rtm-pushes#thread_untagged" class="css-kbi7q3"><code>thread_untagged</code></a></td></tr><tr><td><strong>Customers</strong></td><td><a href="/docs/messaging/agent-chat-api/rtm-pushes#incoming_customers" class="css-kbi7q3"><code>incoming_customers</code></a> <a href="/docs/messaging/agent-chat-api/rtm-pushes#incoming_customer" class="css-kbi7q3"><code>incoming_customer</code></a> <a href="/docs/messaging/agent-chat-api/rtm-pushes#customer_updated" class="css-kbi7q3"><code>customer_updated</code></a> <a href="/docs/messaging/agent-chat-api/rtm-pushes#customer_page_updated" class="css-kbi7q3"><code>customer_page_updated</code></a> <a href="/docs/messaging/agent-chat-api/rtm-pushes#customer_banned" class="css-kbi7q3"><code>customer_banned</code></a> <a href="/docs/messaging/agent-chat-api/rtm-pushes#customer_transferred" class="css-kbi7q3"><code>customer_transferred</code></a> <a href="/docs/messaging/agent-chat-api/rtm-pushes#customer_left" class="css-kbi7q3"><code>customer_left</code></a></td></tr><tr><td><strong>Status</strong></td><td><a href="/docs/messaging/agent-chat-api/rtm-pushes#routing_status_set" class="css-kbi7q3"><code>routing_status_set</code></a> <a href="/docs/messaging/agent-chat-api/rtm-pushes#agent_disconnected" class="css-kbi7q3"><code>agent_disconnected</code></a></td></tr><tr><td><strong>Configuration</strong></td><td><a href="/docs/messaging/agent-chat-api/rtm-pushes#agent_created" class="css-kbi7q3"><code>agent_created</code></a> <a href="/docs/messaging/agent-chat-api/rtm-pushes#agent_approved" class="css-kbi7q3"><code>agent_approved</code></a> <a href="/docs/messaging/agent-chat-api/rtm-pushes#agent_updated" class="css-kbi7q3"><code>agent_updated</code></a> <a href="/docs/messaging/agent-chat-api/rtm-pushes#agent_suspended" class="css-kbi7q3"><code>agent_suspended</code></a> <a href="/docs/messaging/agent-chat-api/rtm-pushes#agent_unsuspended" class="css-kbi7q3"><code>agent_unsuspended</code></a> <a href="/docs/messaging/agent-chat-api/rtm-pushes#agent_deleted" class="css-kbi7q3"><code>agent_deleted</code></a> <a href="/docs/messaging/agent-chat-api/rtm-pushes#auto_accesses_updated" class="css-kbi7q3"><code>auto_accesses_updated</code></a> <a href="/docs/messaging/agent-chat-api/rtm-pushes#bot_created" class="css-kbi7q3"><code>bot_created</code></a> <a href="/docs/messaging/agent-chat-api/rtm-pushes#bot_updated" class="css-kbi7q3"><code>bot_updated</code></a> <a href="/docs/messaging/agent-chat-api/rtm-pushes#bot_deleted" class="css-kbi7q3"><code>bot_deleted</code></a> <a href="/docs/messaging/agent-chat-api/rtm-pushes#group_created" class="css-kbi7q3"><code>group_created</code></a> <a href="/docs/messaging/agent-chat-api/rtm-pushes#group_updated" class="css-kbi7q3"><code>group_updated</code></a> <a href="/docs/messaging/agent-chat-api/rtm-pushes#group_deleted" class="css-kbi7q3"><code>group_deleted</code></a> <a href="/docs/messaging/agent-chat-api/rtm-pushes#tag_created" class="css-kbi7q3"><code>tag_created</code></a> <a href="/docs/messaging/agent-chat-api/rtm-pushes#tag_deleted" class="css-kbi7q3"><code>tag_deleted</code></a> <a href="/docs/messaging/agent-chat-api/rtm-pushes#tag_updated" class="css-kbi7q3"><code>tag_updated</code></a> <a href="/docs/messaging/agent-chat-api/rtm-pushes#groups_status_updated" class="css-kbi7q3"><code>groups_status_updated</code></a></td></tr><tr><td><strong>Other</strong></td><td><a href="/docs/messaging/agent-chat-api/rtm-pushes#events_marked_as_seen" class="css-kbi7q3"><code>events_marked_as_seen</code></a> <a href="/docs/messaging/agent-chat-api/rtm-pushes#incoming_sneak_peek" class="css-kbi7q3"><code>incoming_sneak_peek</code></a> <a href="/docs/messaging/agent-chat-api/rtm-pushes#incoming_typing_indicator" class="css-kbi7q3"><code>incoming_typing_indicator</code></a> <a href="/docs/messaging/agent-chat-api/rtm-pushes#incoming_multicast" class="css-kbi7q3"><code>incoming_multicast</code></a> <a href="/docs/messaging/agent-chat-api/rtm-pushes#chat_unfollowed" class="css-kbi7q3"><code>chat_unfollowed</code></a> <a href="/docs/messaging/agent-chat-api/rtm-pushes#queue_positions_updated" class="css-kbi7q3"><code>queue_positions_updated</code></a> <a href="/docs/messaging/agent-chat-api/rtm-pushes#customer-unfollowed" class="css-kbi7q3"><code>customer_unfollowed</code></a></td></tr></tbody></table></div></div><style data-emotion-css="17buymi">.css-17buymi{width:100%;}@media (min-width:768px){.css-17buymi{padding:25px 25px 30px 0px;}}</style><div class="css-17buymi"><style data-emotion-css="1vuwrgc">.css-1vuwrgc{border:1px solid #e8e8e8;border-radius:6px;background-color:#f1f6f8;min-height:0;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-flex-direction:column;-ms-flex-direction:column;flex-direction:column;margin:0 0 20px;max-width:100%;}.css-1vuwrgc .remark-highlight{min-height:0;}.css-1vuwrgc pre{min-height:0;}</style><div class="css-1vuwrgc"><style data-emotion-css="iwgofq">.css-iwgofq{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-box-pack:justify;-webkit-justify-content:space-between;-ms-flex-pack:justify;justify-content:space-between;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;padding:5px 15px;height:42px;background-color:#dee5e8;border-radius:5px 5px 0 0;font-size:13px;text-transform:uppercase;-webkit-letter-spacing:0.04em;-moz-letter-spacing:0.04em;-ms-letter-spacing:0.04em;letter-spacing:0.04em;}</style><div class="css-iwgofq"><style data-emotion-css="w6gvpm">.css-w6gvpm{-webkit-box-flex:1;-webkit-flex-grow:1;-ms-flex-positive:1;flex-grow:1;}</style><span class="css-w6gvpm">general push format</span> <style data-emotion-css="1wp1vo7">.css-1wp1vo7{position:relative;-webkit-box-flex:1;-webkit-flex-grow:1;-ms-flex-positive:1;flex-grow:1;width:45px;}</style><div class="css-1wp1vo7"><style data-emotion-css="xnt8k0">.css-xnt8k0{position:relative;min-height:18px;}</style><div class="css-xnt8k0"><style data-emotion-css="6oazep">.css-6oazep{position:absolute;top:0;left:0;right:0;text-align:right;text-transform:capitalize;line-height:20px;font-size:13px;-webkit-box-pack:justify;-webkit-justify-content:space-between;-ms-flex-pack:justify;justify-content:space-between;opacity:0;-webkit-transition-delay:0.25s;transition-delay:0.25s;-webkit-transition:none;transition:none;}</style><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><style data-emotion-css="139ndot">.css-139ndot{position:absolute;top:0;right:0;text-align:right;max-width:24px;opacity:1;-webkit-transition-delay:0.25;transition-delay:0.25;-webkit-transition:opacity 0.25s ease-in-out;transition:opacity 0.25s ease-in-out;}.css-139ndot:hover{cursor:pointer;}</style><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><style data-emotion-css="ju12u0">.css-ju12u0{min-height:0;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;max-width:100%;overflow:scroll;}.css-ju12u0 code{display:inline-block;}</style><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"version"</span><span class="token operator">:</span> <span class="token string">"<api_version>"</span><span class="token punctuation">,</span> <span class="token property">"request_id"</span><span class="token operator">:</span> <span class="token string">"<request_id>"</span><span class="token punctuation">,</span> <span class="token comment">// optional, applies only to the requester</span> <span class="token property">"action"</span><span class="token operator">:</span> <span class="token string">"<action>"</span><span class="token punctuation">,</span> <span class="token property">"type"</span><span class="token operator">:</span> <span class="token string">"push"</span><span class="token punctuation">,</span> <span class="token property">"payload"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token comment">// optional payload</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><h3 class="heading"><a id="chats" href="#chats" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#chats"><span class="icon icon-link"></span></a>Chats</a></h3><h4 class="heading"><a id="incoming_chat" href="#incoming_chat" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#incoming_chat"><span class="icon icon-link"></span></a><code>incoming_chat</code></a></h4><p>Informs about a chat coming with a new thread. The push payload contains the whole chat data structure. If the chat was started with some initial events, the thread object contains them.</p><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Sample push payload</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"requester_id"</span><span class="token operator">:</span> <span class="token string">"smith@example.com"</span><span class="token punctuation">,</span> <span class="token property">"chat"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"id"</span><span class="token operator">:</span> <span class="token string">"PJ0MRSHTDG"</span><span class="token punctuation">,</span> <span class="token property">"users"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token comment">// array of "User" objects</span> <span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token property">"properties"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"0805e283233042b37f460ed8fbf22160"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"string_property"</span><span class="token operator">:</span> <span class="token string">"string value"</span> <span class="token punctuation">}</span> <span class="token comment">// ...</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"thread"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token comment">// "Thread" object</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"transferred_from"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"group_ids"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token number">1</span> <span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token property">"agent_ids"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token string">"agent@example.com"</span> <span class="token punctuation">]</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span> </code></pre></div></div></div><h4 class="heading"><a id="chat_deactivated" href="#chat_deactivated" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#chat_deactivated"><span class="icon icon-link"></span></a><code>chat_deactivated</code></a></h4><p>Informs that a chat was deactivated by closing the currently open thread.</p><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Sample push payload</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"chat_id"</span><span class="token operator">:</span> <span class="token string">"PJ0MRSHTDG"</span><span class="token punctuation">,</span> <span class="token property">"thread_id"</span><span class="token operator">:</span> <span class="token string">"K600PKZON8"</span><span class="token punctuation">,</span> <span class="token property">"user_id"</span><span class="token operator">:</span> <span class="token string">"b7eff798-f8df-4364-8059-649c35c9ed0c"</span> <span class="token comment">// optional</span> <span class="token punctuation">}</span> </code></pre></div></div></div><h5 class="heading"><a id="push-payload" href="#push-payload" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#push-payload"><span class="icon icon-link"></span></a>Push payload</a></h5><div class="css-q76ucn"><table><thead><tr><th>Field</th><th>Notes</th></tr></thead><tbody><tr><td><code>user_id</code></td><td>Missing if a thread was closed by the router.</td></tr></tbody></table></div><h4 class="heading"><a id="chat_deleted" href="#chat_deleted" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#chat_deleted"><span class="icon icon-link"></span></a><code>chat_deleted</code></a></h4><p>Informs that a chat was deleted.</p><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Sample push payload</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"chat_id"</span><span class="token operator">:</span> <span class="token string">"PJ0MRSHTDG"</span> <span class="token punctuation">}</span> </code></pre></div></div></div><h4 class="heading"><a id="thread_deleted" href="#thread_deleted" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#thread_deleted"><span class="icon icon-link"></span></a><code>thread_deleted</code></a></h4><p>Informs that a thread was deleted.</p><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Sample push payload</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"chat_id"</span><span class="token operator">:</span> <span class="token string">"PJ0MRSHTDG"</span><span class="token punctuation">,</span> <span class="token property">"thread_id"</span><span class="token operator">:</span> <span class="token string">"K600PKZON8"</span> <span class="token punctuation">}</span> </code></pre></div></div></div><h4 class="heading"><a id="threads_deleted" href="#threads_deleted" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#threads_deleted"><span class="icon icon-link"></span></a><code>threads_deleted</code></a></h4><p>Informs that several threads from a specific date range or with the same tag were deleted.</p><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Sample push payload</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"date_from"</span><span class="token operator">:</span> <span class="token string">"2017-10-12T15:19:21.010200Z"</span><span class="token punctuation">,</span> <span class="token property">"date_to"</span><span class="token operator">:</span> <span class="token string">"2019-10-12T15:19:21.010200Z"</span><span class="token punctuation">,</span> <span class="token property">"tag"</span><span class="token operator">:</span> <span class="token string">"bug_report"</span> <span class="token punctuation">}</span> </code></pre></div></div></div><h3 class="heading"><a id="chat-access" href="#chat-access" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#chat-access"><span class="icon icon-link"></span></a>Chat access</a></h3><h4 class="heading"><a id="chat_access_updated" href="#chat_access_updated" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#chat_access_updated"><span class="icon icon-link"></span></a><code>chat_access_updated</code></a></h4><p>Informs about the update of a user's access to a particular chat. It contains the updated <a href="/docs/messaging/agent-chat-api/v3.5/data-structures#access-1">access</a> data structure.</p><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Sample push payload</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"id"</span><span class="token operator">:</span> <span class="token string">"PJ0MRSHTDG"</span><span class="token punctuation">,</span> <span class="token property">"access"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"group_ids"</span><span class="token operator">:</span> <span class="token punctuation">[</span><span class="token number">0</span><span class="token punctuation">,</span> <span class="token number">1</span><span class="token punctuation">]</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span> </code></pre></div></div></div><h5 class="heading"><a id="push-payload-1" href="#push-payload-1" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#push-payload-1"><span class="icon icon-link"></span></a>Push payload</a></h5><div class="css-q76ucn"><table><thead><tr><th>Field</th><th>Notes</th></tr></thead><tbody><tr><td><code>id</code></td><td>Chat ID</td></tr><tr><td><code>access</code></td><td>The updated chat <a href="/docs/messaging/agent-chat-api/v3.5/data-structures#access-1">access</a> data structure</td></tr></tbody></table></div><h4 class="heading"><a id="chat_transferred" href="#chat_transferred" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#chat_transferred"><span class="icon icon-link"></span></a><code>chat_transferred</code></a></h4><p>Informs that a chat was transferred to a different group or to an agent.</p><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Sample push payload</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"chat_id"</span><span class="token operator">:</span> <span class="token string">"PJ0MRSHTDG"</span><span class="token punctuation">,</span> <span class="token property">"thread_id"</span><span class="token operator">:</span> <span class="token string">"K600PKZON8"</span><span class="token punctuation">,</span> <span class="token property">"requester_id"</span><span class="token operator">:</span> <span class="token string">"jones@example.com"</span><span class="token punctuation">,</span> <span class="token property">"reason"</span><span class="token operator">:</span> <span class="token string">"manual"</span><span class="token punctuation">,</span> <span class="token property">"transferred_to"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"group_ids"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token number">19</span> <span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token property">"agent_ids"</span><span class="token operator">:</span> <span class="token punctuation">[</span><span class="token string">"smith@example.com"</span><span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"queue"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"position"</span><span class="token operator">:</span> <span class="token number">42</span><span class="token punctuation">,</span> <span class="token property">"wait_time"</span><span class="token operator">:</span> <span class="token number">1337</span><span class="token punctuation">,</span> <span class="token property">"queued_at"</span><span class="token operator">:</span> <span class="token string">"2019-12-09T12:01:18.909000Z"</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span> </code></pre></div></div></div><h5 class="heading"><a id="push-payload-2" href="#push-payload-2" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#push-payload-2"><span class="icon icon-link"></span></a>Push payload</a></h5><div class="css-q76ucn"><table><thead><tr><th>Field</th><th>Notes</th></tr></thead><tbody><tr><td><code>thread_id</code></td><td>Present if the chat is active.</td></tr><tr><td><code>transferred_to</code></td><td>IDs of the groups and agents the chat is assigned to after the transfer.</td></tr><tr><td><code>reason</code> <strong>*</strong></td><td>Informs why the chat was transferred.</td></tr><tr><td><code>queue</code></td><td>Present if the chat is queued after the transfer.</td></tr></tbody></table></div><p><strong>*)</strong> Possible reasons: <code>manual</code>, <code>inactive</code>, <code>assigned</code>, <code>unassigned</code>, <code>other</code>.</p><h3 class="heading"><a id="chat-users" href="#chat-users" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#chat-users"><span class="icon icon-link"></span></a>Chat users</a></h3><h4 class="heading"><a id="user_added_to_chat" href="#user_added_to_chat" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#user_added_to_chat"><span class="icon icon-link"></span></a><code>user_added_to_chat</code></a></h4><p>Informs that a user (Customer or Agent) was added to a chat.</p><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Sample push payload</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"chat_id"</span><span class="token operator">:</span> <span class="token string">"PJ0MRSHTDG"</span><span class="token punctuation">,</span> <span class="token property">"thread_id"</span><span class="token operator">:</span> <span class="token string">"K600PKZON8"</span><span class="token punctuation">,</span> <span class="token property">"user"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token comment">// "User > Customer" or "User > Agent" object</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"reason"</span><span class="token operator">:</span> <span class="token string">"manual"</span><span class="token punctuation">,</span> <span class="token property">"requester_id"</span><span class="token operator">:</span> <span class="token string">"smith@example.com"</span> <span class="token punctuation">}</span> </code></pre></div></div></div><h5 class="heading"><a id="push-payload-3" href="#push-payload-3" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#push-payload-3"><span class="icon icon-link"></span></a>Push payload</a></h5><div class="css-q76ucn"><table><thead><tr><th>Field</th><th>Notes</th></tr></thead><tbody><tr><td><code>thread_id</code></td><td>Present when a user was added to an active chat.</td></tr><tr><td><code>reason</code></td><td>Why the user was added.</td></tr><tr><td><code>requester_id</code></td><td>Present if the user was added by an agent.</td></tr></tbody></table></div><h4 class="heading"><a id="user_removed_from_chat" href="#user_removed_from_chat" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#user_removed_from_chat"><span class="icon icon-link"></span></a><code>user_removed_from_chat</code></a></h4><p>Informs that a user (Customer or Agent) was removed from a chat.</p><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Sample push payload</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"chat_id"</span><span class="token operator">:</span> <span class="token string">"PJ0MRSHTDG"</span><span class="token punctuation">,</span> <span class="token property">"thread_id"</span><span class="token operator">:</span> <span class="token string">"K600PKZON8"</span><span class="token punctuation">,</span> <span class="token property">"user_id"</span><span class="token operator">:</span> <span class="token string">"agent@example.com"</span><span class="token punctuation">,</span> <span class="token property">"reason"</span><span class="token operator">:</span> <span class="token string">"manual"</span><span class="token punctuation">,</span> <span class="token property">"requester_id"</span><span class="token operator">:</span> <span class="token string">"smith@example.com"</span> <span class="token punctuation">}</span> </code></pre></div></div></div><h5 class="heading"><a id="push-payload-4" href="#push-payload-4" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#push-payload-4"><span class="icon icon-link"></span></a>Push payload</a></h5><div class="css-q76ucn"><table><thead><tr><th>Field</th><th>Notes</th></tr></thead><tbody><tr><td><code>thread_id</code></td><td>Present when a user was removed from an active chat.</td></tr><tr><td><code>reason</code></td><td>Why the user was removed.</td></tr><tr><td><code>requester_id</code></td><td>Present if the user was removed by an agent.</td></tr></tbody></table></div><h3 class="heading"><a id="events" href="#events" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#events"><span class="icon icon-link"></span></a>Events</a></h3><h4 class="heading"><a id="incoming_event" href="#incoming_event" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#incoming_event"><span class="icon icon-link"></span></a><code>incoming_event</code></a></h4><p>Informs about an incoming <a href="/docs/messaging/agent-chat-api/v3.5/data-structures#events">event</a> sent to a chat.</p><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Sample push payload</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"chat_id"</span><span class="token operator">:</span> <span class="token string">"PJ0MRSHTDG"</span><span class="token punctuation">,</span> <span class="token property">"thread_id"</span><span class="token operator">:</span> <span class="token string">"K600PKZON8"</span><span class="token punctuation">,</span> <span class="token property">"event"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"id"</span><span class="token operator">:</span> <span class="token string">"Q20163UAHO_2"</span><span class="token punctuation">,</span> <span class="token property">"created_at"</span><span class="token operator">:</span> <span class="token string">"2019-12-05T07:27:08.820000Z"</span><span class="token punctuation">,</span> <span class="token property">"visibility"</span><span class="token operator">:</span> <span class="token string">"all"</span><span class="token punctuation">,</span> <span class="token property">"type"</span><span class="token operator">:</span> <span class="token string">"message"</span><span class="token punctuation">,</span> <span class="token property">"properties"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"0805e283233042b37f460ed8fbf22160"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"string_property"</span><span class="token operator">:</span> <span class="token string">"string value"</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"text"</span><span class="token operator">:</span> <span class="token string">"Hello"</span><span class="token punctuation">,</span> <span class="token property">"author_id"</span><span class="token operator">:</span> <span class="token string">"b7eff798-f8df-4364-8059-649c35c9ed0c"</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span> </code></pre></div></div></div><h4 class="heading"><a id="event_updated" href="#event_updated" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#event_updated"><span class="icon icon-link"></span></a><code>event_updated</code></a></h4><p>Informs that an <a href="/docs/messaging/agent-chat-api/v3.5/data-structures#events">event</a> was updated.</p><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Sample push payload</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"chat_id"</span><span class="token operator">:</span> <span class="token string">"123-123-123-123"</span><span class="token punctuation">,</span> <span class="token property">"thread_id"</span><span class="token operator">:</span> <span class="token string">"E2WDHA8A"</span><span class="token punctuation">,</span> <span class="token property">"event"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token comment">// "Event" object</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span> </code></pre></div></div></div><h4 class="heading"><a id="incoming_rich_message_postback" href="#incoming_rich_message_postback" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#incoming_rich_message_postback"><span class="icon icon-link"></span></a><code>incoming_rich_message_postback</code></a></h4><p>Informs about an incoming <a href="/docs/messaging/agent-chat-api/v3.5/data-structures#rich-message">rich message</a> postback. The push payload contains the info on the postback itself, as well as the chat it was sent in.</p><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Sample push payload</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"user_id"</span><span class="token operator">:</span> <span class="token string">"b7eff798-f8df-4364-8059-649c35c9ed0c"</span><span class="token punctuation">,</span> <span class="token property">"chat_id"</span><span class="token operator">:</span> <span class="token string">"PJ0MRSHTDG"</span><span class="token punctuation">,</span> <span class="token property">"thread_id"</span><span class="token operator">:</span> <span class="token string">"K600PKZON8"</span><span class="token punctuation">,</span> <span class="token property">"event_id"</span><span class="token operator">:</span> <span class="token string">"a0c22fdd-fb71-40b5-bfc6-a8a0bc3117f7"</span><span class="token punctuation">,</span> <span class="token property">"postback"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"id"</span><span class="token operator">:</span> <span class="token string">"action_yes"</span><span class="token punctuation">,</span> <span class="token property">"toggled"</span><span class="token operator">:</span> <span class="token boolean">true</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span> </code></pre></div></div></div><h3 class="heading"><a id="properties" href="#properties" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#properties"><span class="icon icon-link"></span></a>Properties</a></h3><h4 class="heading"><a id="chat_properties_updated" href="#chat_properties_updated" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#chat_properties_updated"><span class="icon icon-link"></span></a><code>chat_properties_updated</code></a></h4><p>Informs about those chat properties that were updated.</p><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Sample push payload</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"chat_id"</span><span class="token operator">:</span> <span class="token string">"PJ0MRSHTDG"</span><span class="token punctuation">,</span> <span class="token property">"properties"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"rating"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"score"</span><span class="token operator">:</span> <span class="token number">1</span><span class="token punctuation">,</span> <span class="token property">"comment"</span><span class="token operator">:</span> <span class="token string">"Well done!"</span> <span class="token punctuation">}</span> <span class="token comment">// ...</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span> </code></pre></div></div></div><h5 class="heading"><a id="push-payload-5" href="#push-payload-5" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#push-payload-5"><span class="icon icon-link"></span></a>Push payload</a></h5><div class="css-q76ucn"><table><thead><tr><th>Field</th><th>Notes</th></tr></thead><tbody><tr><td><code>properties</code></td><td>This is not a full <code>properties</code> object. This push shows only the properties that have been recently updated.</td></tr></tbody></table></div><h4 class="heading"><a id="chat_properties_deleted" href="#chat_properties_deleted" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#chat_properties_deleted"><span class="icon icon-link"></span></a><code>chat_properties_deleted</code></a></h4><p>Informs about those chat properties that were deleted.</p><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Sample push payload</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"chat_id"</span><span class="token operator">:</span> <span class="token string">"PJ0MRSHTDG"</span><span class="token punctuation">,</span> <span class="token property">"properties"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"rating"</span><span class="token operator">:</span> <span class="token punctuation">[</span><span class="token string">"score"</span><span class="token punctuation">,</span> <span class="token string">"comment"</span><span class="token punctuation">]</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token comment">// ...</span> <span class="token punctuation">}</span> </code></pre></div></div></div><h5 class="heading"><a id="push-payload-6" href="#push-payload-6" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#push-payload-6"><span class="icon icon-link"></span></a>Push payload</a></h5><div class="css-q76ucn"><table><thead><tr><th>Field</th><th>Notes</th></tr></thead><tbody><tr><td><code>properties</code></td><td>This is not a full <code>properties</code> object. This push shows only the properties that have been recently updated.</td></tr></tbody></table></div><h4 class="heading"><a id="thread_properties_updated" href="#thread_properties_updated" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#thread_properties_updated"><span class="icon icon-link"></span></a><code>thread_properties_updated</code></a></h4><p>Informs about those thread properties that were updated.</p><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Sample push payload</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"chat_id"</span><span class="token operator">:</span> <span class="token string">"PJ0MRSHTDG"</span><span class="token punctuation">,</span> <span class="token property">"thread_id"</span><span class="token operator">:</span> <span class="token string">"K600PKZON8"</span><span class="token punctuation">,</span> <span class="token property">"properties"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"rating"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"score"</span><span class="token operator">:</span> <span class="token number">1</span><span class="token punctuation">,</span> <span class="token property">"comment"</span><span class="token operator">:</span> <span class="token string">"Well done!"</span> <span class="token punctuation">}</span> <span class="token comment">// ...</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span> </code></pre></div></div></div><h5 class="heading"><a id="push-payload-7" href="#push-payload-7" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#push-payload-7"><span class="icon icon-link"></span></a>Push payload</a></h5><div class="css-q76ucn"><table><thead><tr><th>Field</th><th>Notes</th></tr></thead><tbody><tr><td><code>properties</code></td><td>This is not a full <code>properties</code> object. This push shows only the properties that have been recently updated.</td></tr></tbody></table></div><h4 class="heading"><a id="thread_properties_deleted" href="#thread_properties_deleted" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#thread_properties_deleted"><span class="icon icon-link"></span></a><code>thread_properties_deleted</code></a></h4><p>Informs about those thread properties that were deleted.</p><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Sample push payload</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"chat_id"</span><span class="token operator">:</span> <span class="token string">"PJ0MRSHTDG"</span><span class="token punctuation">,</span> <span class="token property">"thread_id"</span><span class="token operator">:</span> <span class="token string">"K600PKZON8"</span><span class="token punctuation">,</span> <span class="token property">"properties"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"rating"</span><span class="token operator">:</span> <span class="token punctuation">[</span><span class="token string">"score"</span><span class="token punctuation">,</span> <span class="token string">"comment"</span><span class="token punctuation">]</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token comment">// ...</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span> </code></pre></div></div></div><h5 class="heading"><a id="push-payload-8" href="#push-payload-8" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#push-payload-8"><span class="icon icon-link"></span></a>Push payload</a></h5><div class="css-q76ucn"><table><thead><tr><th>Field</th><th>Notes</th></tr></thead><tbody><tr><td><code>properties</code></td><td>This is not a full <code>properties</code> object. This push shows only the properties that have been recently updated.</td></tr></tbody></table></div><h4 class="heading"><a id="event_properties_updated" href="#event_properties_updated" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#event_properties_updated"><span class="icon icon-link"></span></a><code>event_properties_updated</code></a></h4><p>Informs about those event properties that were updated.</p><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Sample push payload</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"chat_id"</span><span class="token operator">:</span> <span class="token string">"PJ0MRSHTDG"</span><span class="token punctuation">,</span> <span class="token property">"thread_id"</span><span class="token operator">:</span> <span class="token string">"K600PKZON8"</span><span class="token punctuation">,</span> <span class="token property">"event_id"</span><span class="token operator">:</span> <span class="token string">"2_E2WDHA8A"</span><span class="token punctuation">,</span> <span class="token property">"properties"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"rating"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"score"</span><span class="token operator">:</span> <span class="token number">1</span><span class="token punctuation">,</span> <span class="token property">"comment"</span><span class="token operator">:</span> <span class="token string">"Well done!"</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span> </code></pre></div></div></div><h5 class="heading"><a id="push-payload-9" href="#push-payload-9" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#push-payload-9"><span class="icon icon-link"></span></a>Push payload</a></h5><div class="css-q76ucn"><table><thead><tr><th>Field</th><th>Notes</th></tr></thead><tbody><tr><td><code>properties</code></td><td>This is not a full <code>properties</code> object. This push shows only the properties that have been recently updated.</td></tr></tbody></table></div><h4 class="heading"><a id="event_properties_deleted" href="#event_properties_deleted" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#event_properties_deleted"><span class="icon icon-link"></span></a><code>event_properties_deleted</code></a></h4><p>Informs about those event properties that were deleted.</p><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Sample push payload</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"chat_id"</span><span class="token operator">:</span> <span class="token string">"PJ0MRSHTDG"</span><span class="token punctuation">,</span> <span class="token property">"thread_id"</span><span class="token operator">:</span> <span class="token string">"K600PKZON8"</span><span class="token punctuation">,</span> <span class="token property">"event_id"</span><span class="token operator">:</span> <span class="token string">"2_E2WDHA8A"</span><span class="token punctuation">,</span> <span class="token property">"properties"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"rating"</span><span class="token operator">:</span> <span class="token punctuation">[</span><span class="token string">"score"</span><span class="token punctuation">,</span> <span class="token string">"comment"</span><span class="token punctuation">]</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token comment">// ...</span> <span class="token punctuation">}</span> </code></pre></div></div></div><h5 class="heading"><a id="push-payload-10" href="#push-payload-10" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#push-payload-10"><span class="icon icon-link"></span></a>Push payload</a></h5><div class="css-q76ucn"><table><thead><tr><th>Field</th><th>Notes</th></tr></thead><tbody><tr><td><code>properties</code></td><td>This is not a full <code>properties</code> object. This push shows only the properties that have been recently updated.</td></tr></tbody></table></div><h3 class="heading"><a id="thread-tags" href="#thread-tags" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#thread-tags"><span class="icon icon-link"></span></a>Thread tags</a></h3><h4 class="heading"><a id="thread_tagged" href="#thread_tagged" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#thread_tagged"><span class="icon icon-link"></span></a><code>thread_tagged</code></a></h4><p>Informs that a chat thread was tagged.</p><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Sample push payload</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"chat_id"</span><span class="token operator">:</span> <span class="token string">"PJ0MRSHTDG"</span><span class="token punctuation">,</span> <span class="token property">"thread_id"</span><span class="token operator">:</span> <span class="token string">"K600PKZON8"</span><span class="token punctuation">,</span> <span class="token property">"tag"</span><span class="token operator">:</span> <span class="token string">"bug_report"</span> <span class="token punctuation">}</span> </code></pre></div></div></div><h4 class="heading"><a id="thread_untagged" href="#thread_untagged" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#thread_untagged"><span class="icon icon-link"></span></a><code>thread_untagged</code></a></h4><p>Informs that a chat thread was untagged.</p><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Sample push payload</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"chat_id"</span><span class="token operator">:</span> <span class="token string">"PJ0MRSHTDG"</span><span class="token punctuation">,</span> <span class="token property">"thread_id"</span><span class="token operator">:</span> <span class="token string">"K600PKZON8"</span><span class="token punctuation">,</span> <span class="token property">"tag"</span><span class="token operator">:</span> <span class="token string">"bug_report"</span> <span class="token punctuation">}</span> </code></pre></div></div></div><h3 class="heading"><a id="customers" href="#customers" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#customers"><span class="icon icon-link"></span></a>Customers</a></h3><h4 class="heading"><a id="incoming_customers" href="#incoming_customers" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#incoming_customers"><span class="icon icon-link"></span></a><code>incoming_customers</code></a></h4><p>Informs about customers the agent should be aware of. It's sent after <a href="/docs/messaging/agent-chat-api/rtm-reference#login" class="css-kbi7q3"><code>login</code></a>.</p><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Sample push payload</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"customer_monitoring_level"</span><span class="token operator">:</span> <span class="token string">"invited"</span><span class="token punctuation">,</span> <span class="token property">"customers"</span><span class="token operator">:</span> <span class="token punctuation">[</span><span class="token punctuation">{</span> <span class="token comment">// "Customer" user object</span> <span class="token punctuation">}</span><span class="token punctuation">]</span> <span class="token punctuation">}</span> </code></pre></div></div></div><h4 class="heading"><a id="incoming_customer" href="#incoming_customer" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#incoming_customer"><span class="icon icon-link"></span></a><code>incoming_customer</code></a></h4><p>Informs that a new or returning customer is available to the agent. It's sent when:</p><ul><li>a new customer registers.</li><li>a customer, who previously left the tracked website, returns.</li><li>an already followed customer, who was temporarily unavailable to the agent, becomes available again (for example, the customer was transferred between groups).</li></ul><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Sample push payload</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token comment">// "Customer" user object</span> <span class="token punctuation">}</span> </code></pre></div></div></div><h4 class="heading"><a id="customer_updated" href="#customer_updated" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#customer_updated"><span class="icon icon-link"></span></a><code>customer_updated</code></a></h4><p>Informs that customer's data changed. The push payload contains the updated fields.</p><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Sample push payload</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"id"</span><span class="token operator">:</span> <span class="token string">"b7eff798-f8df-4364-8059-649c35c9ed0c"</span><span class="token punctuation">,</span> <span class="token property">"name"</span><span class="token operator">:</span> <span class="token string">"Thomas Anderson"</span><span class="token punctuation">,</span> <span class="token property">"email"</span><span class="token operator">:</span> <span class="token string">"t.anderson@example.com"</span><span class="token punctuation">,</span> <span class="token property">"avatar"</span><span class="token operator">:</span> <span class="token string">"https://example.com/avatars/1.jpg"</span><span class="token punctuation">,</span> <span class="token property">"type"</span><span class="token operator">:</span> <span class="token string">"customer"</span><span class="token punctuation">,</span> <span class="token property">"session_fields"</span><span class="token operator">:</span> <span class="token punctuation">[</span><span class="token punctuation">{</span> <span class="token property">"custom_key"</span><span class="token operator">:</span> <span class="token string">"custom_value"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span> <span class="token property">"another_custom_key"</span><span class="token operator">:</span> <span class="token string">"another_custom_value"</span> <span class="token punctuation">}</span><span class="token punctuation">]</span> <span class="token punctuation">}</span> </code></pre></div></div></div><h4 class="heading"><a id="customer_page_updated" href="#customer_page_updated" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#customer_page_updated"><span class="icon icon-link"></span></a><code>customer_page_updated</code></a></h4><p>Informs that a Customer moved to another page of the website.</p><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Sample push payload</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"customer_id"</span><span class="token operator">:</span> <span class="token string">"b7eff798-f8df-4364-8059-649c35c9ed0c"</span><span class="token punctuation">,</span> <span class="token property">"visit_id"</span><span class="token operator">:</span> <span class="token number">42</span><span class="token punctuation">,</span> <span class="token property">"opened_at"</span><span class="token operator">:</span> <span class="token string">"2017-10-12T15:19:21.010200Z"</span><span class="token punctuation">,</span> <span class="token property">"url"</span><span class="token operator">:</span> <span class="token string">"https://www.livechat.com/"</span><span class="token punctuation">,</span> <span class="token property">"title"</span><span class="token operator">:</span> <span class="token string">"LiveChat - Homepage"</span> <span class="token punctuation">}</span> </code></pre></div></div></div><h4 class="heading"><a id="customer_banned" href="#customer_banned" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#customer_banned"><span class="icon icon-link"></span></a><code>customer_banned</code></a></h4><p>Informs that a Customer was banned for a specified number of days.</p><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Sample push payload</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"customer_id"</span><span class="token operator">:</span> <span class="token string">"b7eff798-f8df-4364-8059-649c35c9ed0c"</span><span class="token punctuation">,</span> <span class="token property">"ban"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"days"</span><span class="token operator">:</span> <span class="token number">5</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span> </code></pre></div></div></div><h4 class="heading"><a id="customer_transferred" href="#customer_transferred" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#customer_transferred"><span class="icon icon-link"></span></a><code>customer_transferred</code></a></h4><p>Informs that a customer is no longer available to the agent.</p><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Sample push payload</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"id"</span><span class="token operator">:</span> <span class="token string">"b7eff798-f8df-4364-8059-649c35c9ed0c"</span><span class="token punctuation">,</span> <span class="token property">"transferred_to"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"group_ids"</span><span class="token operator">:</span> <span class="token punctuation">[</span><span class="token number">1</span><span class="token punctuation">]</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"followed"</span><span class="token operator">:</span> <span class="token boolean">true</span> <span class="token punctuation">}</span> </code></pre></div></div></div><h4 class="heading"><a id="customer_left" href="#customer_left" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#customer_left"><span class="icon icon-link"></span></a><code>customer_left</code></a></h4><p>Informs that a Customer left the tracked website.</p><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Sample push payload</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"id"</span><span class="token operator">:</span> <span class="token string">"b7eff798-f8df-4364-8059-649c35c9ed0c"</span><span class="token punctuation">,</span> <span class="token property">"left_at"</span><span class="token operator">:</span> <span class="token string">"2017-10-12T15:19:21.010200Z"</span> <span class="token punctuation">}</span> </code></pre></div></div></div><h3 class="heading"><a id="status" href="#status" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#status"><span class="icon icon-link"></span></a>Status</a></h3><h4 class="heading"><a id="routing_status_set" href="#routing_status_set" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#routing_status_set"><span class="icon icon-link"></span></a><code>routing_status_set</code></a></h4><p>Informs that an Agent's or Bot Agent's status was changed.</p><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Sample push payload</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"agent_id"</span><span class="token operator">:</span> <span class="token string">"smith@example.com"</span><span class="token punctuation">,</span> <span class="token property">"status"</span><span class="token operator">:</span> <span class="token string">"accepting_chats"</span> <span class="token punctuation">}</span> </code></pre></div></div></div><h4 class="heading"><a id="agent_disconnected" href="#agent_disconnected" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#agent_disconnected"><span class="icon icon-link"></span></a><code>agent_disconnected</code></a></h4><p>Informs that an Agent was disconnected. The payload contains the reason of Customer's disconnection.</p><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Sample push payload</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"reason"</span><span class="token operator">:</span> <span class="token string">"misdirected_request"</span><span class="token punctuation">,</span> <span class="token property">"data"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token comment">// optional</span> <span class="token property">"region"</span><span class="token operator">:</span> <span class="token string">"fra"</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span> </code></pre></div></div></div><h5 class="heading"><a id="possible-reasons" href="#possible-reasons" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#possible-reasons"><span class="icon icon-link"></span></a>Possible reasons</a></h5><p>Based on the received <code>reason</code> we suggest a different reaction.</p><div class="css-q76ucn"><table><thead><tr><th>Type</th><th>Notes</th><th>Suggested behavior</th></tr></thead><tbody><tr><td><code>agent_disconnected_by_server</code></td><td>Agent has been disconnected by the server.</td><td>Don't reconnect.</td></tr><tr><td><code>agent_logged_out_remotely</code></td><td>Agent has been logged out remotely.</td><td>Don't reconnect.</td></tr><tr><td><code>access_token_revoked</code></td><td>Agent access token has been revoked.</td><td>Don't reconnect.</td></tr><tr><td><code>connection_evicted</code></td><td>Sent to the connection that's replaced by a newly established one, and the new connection exceeded the limit of possible connections.</td><td>Don't reconnect.</td></tr><tr><td><code>access_token_expired</code></td><td>Access token lifetime has elapsed.</td><td>Reconnect and generate a new access token.</td></tr><tr><td><code>connection_timeout</code></td><td>Has not received <a href="/docs/messaging/agent-chat-api/rtm-pushes#authentication" class="css-kbi7q3"><code>ping</code></a> from the client for some time, or it's been too long since the connection was authorized.</td><td>Reconnect.</td></tr><tr><td><code>internal_error</code></td><td>Internal error.</td><td>Reconnect.</td></tr><tr><td><code>license_expired</code></td><td>License has expired.</td><td>Don't reconnect.</td></tr><tr><td><code>license_not_found</code></td><td>License with the specified ID doesn't exist.</td><td>Don't reconnect.</td></tr><tr><td><code>misdirected_connection</code> <strong>*</strong></td><td>Agent connected to the server in the wrong region.</td><td>Don't reconnect.</td></tr><tr><td><code>unsupported_version</code></td><td>Connecting to an unsupported version of the Agent API.</td><td>Don't reconnect.</td></tr><tr><td><code>too_many_connections</code></td><td>Agent reached the max. number of connections.</td><td>Don't reconnect.</td></tr><tr><td><code>too_many_unauthorized_connections</code></td><td>Agent reached the max. number of unauthorized connections.</td><td>Reconnect.</td></tr></tbody></table></div><p><strong>*)</strong> Also, <code>misdirected_connection</code> returns the correct <code>region</code> value in the optional <code>data</code> object. With this piece of information, the client is able to figure out where it should be connected.</p><h3 class="heading"><a id="configuration" href="#configuration" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#configuration"><span class="icon icon-link"></span></a>Configuration</a></h3><h4 class="heading"><a id="agent_created" href="#agent_created" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#agent_created"><span class="icon icon-link"></span></a><code>agent_created</code></a></h4><p>Informs that a new agent account was created. The payload contains the full state of the <a href="messaging/agent-chat-api/v3.5/data-structures/#agent">agent</a> data structure, including empty fields.</p><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Sample push payload</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"id"</span><span class="token operator">:</span> <span class="token string">"smith@example.com"</span><span class="token punctuation">,</span> <span class="token property">"name"</span><span class="token operator">:</span> <span class="token string">"Agent Smith"</span><span class="token punctuation">,</span> <span class="token property">"role"</span><span class="token operator">:</span> <span class="token string">"viceowner"</span><span class="token punctuation">,</span> <span class="token property">"awaiting_approval"</span><span class="token operator">:</span> <span class="token boolean">false</span><span class="token punctuation">,</span> <span class="token property">"groups"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"id"</span><span class="token operator">:</span> <span class="token number">5</span><span class="token punctuation">,</span> <span class="token property">"priority"</span><span class="token operator">:</span> <span class="token string">"first"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span> <span class="token property">"id"</span><span class="token operator">:</span> <span class="token number">2</span><span class="token punctuation">,</span> <span class="token property">"priority"</span><span class="token operator">:</span> <span class="token string">"last"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span> <span class="token property">"id"</span><span class="token operator">:</span> <span class="token number">1</span><span class="token punctuation">,</span> <span class="token property">"priority"</span><span class="token operator">:</span> <span class="token string">"normal"</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token property">"notifications"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token string">"new_visitor"</span><span class="token punctuation">,</span> <span class="token string">"new_goal"</span><span class="token punctuation">,</span> <span class="token string">"visitor_is_typing"</span> <span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token property">"email_subscriptions"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token string">"weekly_summary"</span> <span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token property">"work_scheduler"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"timezone"</span><span class="token operator">:</span> <span class="token string">"Europe/Warsaw"</span><span class="token punctuation">,</span> <span class="token property">"schedule"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"day"</span><span class="token operator">:</span> <span class="token string">"monday"</span><span class="token punctuation">,</span> <span class="token property">"enabled"</span><span class="token operator">:</span> <span class="token boolean">true</span><span class="token punctuation">,</span> <span class="token property">"start"</span><span class="token operator">:</span> <span class="token string">"08:30"</span><span class="token punctuation">,</span> <span class="token property">"end"</span><span class="token operator">:</span> <span class="token string">"12:30"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span> <span class="token property">"day"</span><span class="token operator">:</span> <span class="token string">"monday"</span><span class="token punctuation">,</span> <span class="token property">"enabled"</span><span class="token operator">:</span> <span class="token boolean">true</span><span class="token punctuation">,</span> <span class="token property">"start"</span><span class="token operator">:</span> <span class="token string">"13:30"</span><span class="token punctuation">,</span> <span class="token property">"end"</span><span class="token operator">:</span> <span class="token string">"16:30"</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span> </code></pre></div></div></div><h4 class="heading"><a id="agent_approved" href="#agent_approved" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#agent_approved"><span class="icon icon-link"></span></a><code>agent_approved</code></a></h4><p>Informs that an agent's account was approved and is now active.</p><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Sample push payload</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"id"</span><span class="token operator">:</span> <span class="token string">"smith@example.com"</span> <span class="token punctuation">}</span> </code></pre></div></div></div><h4 class="heading"><a id="agent_updated" href="#agent_updated" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#agent_updated"><span class="icon icon-link"></span></a><code>agent_updated</code></a></h4><p>Informs that an agent's configuration changed. Contains only the updated properties.</p><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Sample push payload</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"id"</span><span class="token operator">:</span> <span class="token string">"smith@example.com"</span><span class="token punctuation">,</span> <span class="token property">"work_scheduler"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"timezone"</span><span class="token operator">:</span> <span class="token string">"Europe/Warsaw"</span><span class="token punctuation">,</span> <span class="token property">"schedule"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"day"</span><span class="token operator">:</span> <span class="token string">"monday"</span><span class="token punctuation">,</span> <span class="token property">"enabled"</span><span class="token operator">:</span> <span class="token boolean">true</span><span class="token punctuation">,</span> <span class="token property">"start"</span><span class="token operator">:</span> <span class="token string">"08:30"</span><span class="token punctuation">,</span> <span class="token property">"end"</span><span class="token operator">:</span> <span class="token string">"12:30"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span> <span class="token property">"day"</span><span class="token operator">:</span> <span class="token string">"monday"</span><span class="token punctuation">,</span> <span class="token property">"enabled"</span><span class="token operator">:</span> <span class="token boolean">true</span><span class="token punctuation">,</span> <span class="token property">"start"</span><span class="token operator">:</span> <span class="token string">"13:30"</span><span class="token punctuation">,</span> <span class="token property">"end"</span><span class="token operator">:</span> <span class="token string">"16:30"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span> <span class="token property">"day"</span><span class="token operator">:</span> <span class="token string">"friday"</span><span class="token punctuation">,</span> <span class="token property">"enabled"</span><span class="token operator">:</span> <span class="token boolean">true</span><span class="token punctuation">,</span> <span class="token property">"start"</span><span class="token operator">:</span> <span class="token string">"07:30"</span><span class="token punctuation">,</span> <span class="token property">"end"</span><span class="token operator">:</span> <span class="token string">"21:30"</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span> </code></pre></div></div></div><h4 class="heading"><a id="agent_suspended" href="#agent_suspended" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#agent_suspended"><span class="icon icon-link"></span></a><code>agent_suspended</code></a></h4><p>Informs that an agent's account was suspended.</p><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Sample push payload</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"id"</span><span class="token operator">:</span> <span class="token string">"smith@example.com"</span> <span class="token punctuation">}</span> </code></pre></div></div></div><h4 class="heading"><a id="agent_unsuspended" href="#agent_unsuspended" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#agent_unsuspended"><span class="icon icon-link"></span></a><code>agent_unsuspended</code></a></h4><p>Informs that an agent's account was unsuspended.</p><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Sample push payload</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"id"</span><span class="token operator">:</span> <span class="token string">"smith@example.com"</span> <span class="token punctuation">}</span> </code></pre></div></div></div><h4 class="heading"><a id="agent_deleted" href="#agent_deleted" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#agent_deleted"><span class="icon icon-link"></span></a><code>agent_deleted</code></a></h4><p>Informs that an agent's account was deleted.</p><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Sample push payload</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"id"</span><span class="token operator">:</span> <span class="token string">"smith@example.com"</span> <span class="token punctuation">}</span> </code></pre></div></div></div><h4 class="heading"><a id="auto_accesses_updated" href="#auto_accesses_updated" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#auto_accesses_updated"><span class="icon icon-link"></span></a><code>auto_accesses_updated</code></a></h4><p>Informs that auto access rules were modified. The payload contains an array of all changes done as result of adding, updating, or deleting auto access rule. The resulting payload can contain multiple objects depending on the action:</p><ul><li>for the added <a href="/docs/management/configuration-api/v3.5#auto-access">auto access</a> rule, the payload contains the complete state of the auto access rule data structure, including empty fields.</li><li>for the updated <a href="/docs/management/configuration-api/v3.5#auto-access">auto access</a> rule, the payload contains only the updated properties.</li><li>for the deleted <a href="/docs/management/configuration-api/v3.5#auto-access">auto access</a> rule, the payload confirms the deletion.</li></ul><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Sample push payload after adding auto access rule</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"id"</span><span class="token operator">:</span> <span class="token string">"dc70916fdc9d02ea0bcdee5b2fa64717"</span><span class="token punctuation">,</span> <span class="token property">"next_id"</span><span class="token operator">:</span> <span class="token string">"b1cd0bfea640f671694110c6ae34356f"</span><span class="token punctuation">,</span> <span class="token property">"status"</span><span class="token operator">:</span> <span class="token string">"updated"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span> <span class="token property">"id"</span><span class="token operator">:</span> <span class="token string">"b1cd0bfea640f671694110c6ae34356f"</span><span class="token punctuation">,</span> <span class="token property">"description"</span><span class="token operator">:</span> <span class="token string">""</span><span class="token punctuation">,</span> <span class="token property">"access"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"groups"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token number">0</span> <span class="token punctuation">]</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"conditions"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"url"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"values"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"value"</span><span class="token operator">:</span> <span class="token string">"https://www.auto-access.test"</span><span class="token punctuation">,</span> <span class="token property">"exact_match"</span><span class="token operator">:</span> <span class="token boolean">false</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"domain"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"values"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"value"</span><span class="token operator">:</span> <span class="token string">"https://www.auto-access.test"</span><span class="token punctuation">,</span> <span class="token property">"exact_match"</span><span class="token operator">:</span> <span class="token boolean">true</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"geolocation"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"values"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"country"</span><span class="token operator">:</span> <span class="token string">"United States"</span><span class="token punctuation">,</span> <span class="token property">"country_code"</span><span class="token operator">:</span> <span class="token string">"US"</span><span class="token punctuation">,</span> <span class="token property">"region"</span><span class="token operator">:</span> <span class="token string">"California"</span><span class="token punctuation">,</span> <span class="token property">"city"</span><span class="token operator">:</span> <span class="token string">"Mountain View"</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"next_id"</span><span class="token operator">:</span> <span class="token string">""</span><span class="token punctuation">,</span> <span class="token property">"status"</span><span class="token operator">:</span> <span class="token string">"added"</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Sample push payload after updating auto access rule</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"id"</span><span class="token operator">:</span> <span class="token string">"b1cd0bfea640f671694110c6ae34356f"</span><span class="token punctuation">,</span> <span class="token property">"description"</span><span class="token operator">:</span> <span class="token string">"Auto access updated"</span><span class="token punctuation">,</span> <span class="token property">"next_id"</span><span class="token operator">:</span> <span class="token string">"dc70916fdc9d02ea0bcdee5b2fa64717"</span><span class="token punctuation">,</span> <span class="token property">"status"</span><span class="token operator">:</span> <span class="token string">"updated"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span> <span class="token property">"id"</span><span class="token operator">:</span> <span class="token string">"dc70916fdc9d02ea0bcdee5b2fa64717"</span><span class="token punctuation">,</span> <span class="token property">"next_id"</span><span class="token operator">:</span> <span class="token string">""</span><span class="token punctuation">,</span> <span class="token property">"status"</span><span class="token operator">:</span> <span class="token string">"updated"</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Sample push payload after deleting auto access rule</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"id"</span><span class="token operator">:</span> <span class="token string">"b1cd0bfea640f671694110c6ae34356f"</span><span class="token punctuation">,</span> <span class="token property">"next_id"</span><span class="token operator">:</span> <span class="token string">""</span><span class="token punctuation">,</span> <span class="token property">"status"</span><span class="token operator">:</span> <span class="token string">"updated"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span> <span class="token property">"id"</span><span class="token operator">:</span> <span class="token string">"dc70916fdc9d02ea0bcdee5b2fa64717"</span><span class="token punctuation">,</span> <span class="token property">"status"</span><span class="token operator">:</span> <span class="token string">"deleted"</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span> </code></pre></div></div></div><h4 class="heading"><a id="bot_created" href="#bot_created" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#bot_created"><span class="icon icon-link"></span></a><code>bot_created</code></a></h4><p>Informs that a new bot was added. The payload contains the full state of the <a href="/docs/management/configuration-api/v3.5#bots">bot</a> data structure, including empty fields.</p><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Sample push payload</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"id"</span><span class="token operator">:</span> <span class="token string">"5c9871d5372c824cbf22d860a707a578"</span><span class="token punctuation">,</span> <span class="token property">"name"</span><span class="token operator">:</span> <span class="token string">"Bot Name"</span><span class="token punctuation">,</span> <span class="token property">"default_group_priority"</span><span class="token operator">:</span> <span class="token string">"first"</span><span class="token punctuation">,</span> <span class="token property">"groups"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"id"</span><span class="token operator">:</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token property">"priority"</span><span class="token operator">:</span> <span class="token string">"normal"</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token property">"owner_client_id"</span><span class="token operator">:</span> <span class="token string">"asXdesldiAJSq9padj"</span> <span class="token punctuation">}</span> </code></pre></div></div></div><h4 class="heading"><a id="bot_updated" href="#bot_updated" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#bot_updated"><span class="icon icon-link"></span></a><code>bot_updated</code></a></h4><p>Informs that a bot's configuration changed. Contains only the updated properties.</p><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Sample push payload</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"id"</span><span class="token operator">:</span> <span class="token string">"5c9871d5372c824cbf22d860a707a578"</span><span class="token punctuation">,</span> <span class="token property">"name"</span><span class="token operator">:</span> <span class="token string">"New Bot Name"</span><span class="token punctuation">,</span> <span class="token punctuation">}</span> </code></pre></div></div></div><h4 class="heading"><a id="bot_deleted" href="#bot_deleted" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#bot_deleted"><span class="icon icon-link"></span></a><code>bot_deleted</code></a></h4><p>Informs that a bot was deleted.</p><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Sample push payload</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"id"</span><span class="token operator">:</span> <span class="token string">"5c9871d5372c824cbf22d860a707a578"</span> <span class="token punctuation">}</span> </code></pre></div></div></div><h4 class="heading"><a id="group_created" href="#group_created" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#group_created"><span class="icon icon-link"></span></a><code>group_created</code></a></h4><p>Informs that a group was created within a license. The payload contains the full state of the <a href="/docs/management/configuration-api/v3.5#groups">group</a> data structure, including empty fields.</p><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Sample push payload</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"id"</span><span class="token operator">:</span> <span class="token number">42</span><span class="token punctuation">,</span> <span class="token property">"name"</span><span class="token operator">:</span> <span class="token string">"Sales"</span><span class="token punctuation">,</span> <span class="token property">"language_code"</span><span class="token operator">:</span> <span class="token string">"en"</span><span class="token punctuation">,</span> <span class="token property">"agent_priorities"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"agent@example.com"</span><span class="token operator">:</span> <span class="token string">"normal"</span><span class="token punctuation">,</span> <span class="token property">"other_agent@example.com"</span><span class="token operator">:</span> <span class="token string">"first"</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span> </code></pre></div></div></div><h4 class="heading"><a id="group_deleted" href="#group_deleted" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#group_deleted"><span class="icon icon-link"></span></a><code>group_deleted</code></a></h4><p>Informs that a group was deleted within a license.</p><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Sample push payload</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"id"</span><span class="token operator">:</span> <span class="token number">42</span> <span class="token punctuation">}</span> </code></pre></div></div></div><h4 class="heading"><a id="group_updated" href="#group_updated" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#group_updated"><span class="icon icon-link"></span></a><code>group_updated</code></a></h4><p>Informs that a group was updated within a license. The push payload only includes the updated fields.</p><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Sample push payload</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"id"</span><span class="token operator">:</span> <span class="token number">42</span><span class="token punctuation">,</span> <span class="token property">"name"</span><span class="token operator">:</span> <span class="token string">"Sales"</span> <span class="token punctuation">}</span> </code></pre></div></div></div><h4 class="heading"><a id="tag_created" href="#tag_created" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#tag_created"><span class="icon icon-link"></span></a><code>tag_created</code></a></h4><p>Informs that a tag was created within a license. The payload contains the full state of the <a href="/docs/management/configuration-api/v3.5#tags">tag</a> data structure, including empty fields.</p><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Sample push payload</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"name"</span><span class="token operator">:</span> <span class="token string">"docs_feedback"</span><span class="token punctuation">,</span> <span class="token property">"group_ids"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token number">42</span> <span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token property">"created_at"</span><span class="token operator">:</span> <span class="token string">"2019-12-09T12:01:18.909000Z"</span><span class="token punctuation">,</span> <span class="token property">"author_id"</span><span class="token operator">:</span> <span class="token string">"smith@example.com"</span> <span class="token punctuation">}</span> </code></pre></div></div></div><h4 class="heading"><a id="tag_deleted" href="#tag_deleted" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#tag_deleted"><span class="icon icon-link"></span></a><code>tag_deleted</code></a></h4><p>Informs that a tag was deleted within a license.</p><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Sample push payload</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"name"</span><span class="token operator">:</span> <span class="token string">"docs_feedback"</span> <span class="token punctuation">}</span> </code></pre></div></div></div><h4 class="heading"><a id="tag_updated" href="#tag_updated" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#tag_updated"><span class="icon icon-link"></span></a><code>tag_updated</code></a></h4><p>Informs that a tag was updated within a license.</p><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Sample push payload</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"name"</span><span class="token operator">:</span> <span class="token string">"docs_feedback"</span><span class="token punctuation">,</span> <span class="token property">"group_ids"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token number">42</span> <span class="token punctuation">]</span> <span class="token punctuation">}</span> </code></pre></div></div></div><h4 class="heading"><a id="groups_status_updated" href="#groups_status_updated" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#groups_status_updated"><span class="icon icon-link"></span></a><code>groups_status_updated</code></a></h4><p>Informs that the statuses of groups that the agent has access to were updated. The push payload only includes the updated fields. Possible statuses: <code>accepting_chats</code>, <code>not_accepting_chats</code>, <code>offline</code>.</p><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Sample push payload</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"groups"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"id"</span><span class="token operator">:</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token property">"status"</span><span class="token operator">:</span> <span class="token string">"offline"</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span> <span class="token punctuation">}</span> </code></pre></div></div></div><h3 class="heading"><a id="other" href="#other" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#other"><span class="icon icon-link"></span></a>Other</a></h3><h4 class="heading"><a id="incoming_typing_indicator" href="#incoming_typing_indicator" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#incoming_typing_indicator"><span class="icon icon-link"></span></a><code>incoming_typing_indicator</code></a></h4><p>Informs that one of the chat users is currently typing a message. The message hasn't been sent yet. The push payload contains the typing indicator object.</p><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Sample push payload</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"chat_id"</span><span class="token operator">:</span> <span class="token string">"PJ0MRSHTDG"</span><span class="token punctuation">,</span> <span class="token property">"thread_id"</span><span class="token operator">:</span> <span class="token string">"K600PKZON8"</span><span class="token punctuation">,</span> <span class="token property">"typing_indicator"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"author_id"</span><span class="token operator">:</span> <span class="token string">"smith@example.com"</span><span class="token punctuation">,</span> <span class="token property">"visibility"</span><span class="token operator">:</span> <span class="token string">"all"</span><span class="token punctuation">,</span> <span class="token property">"timestamp"</span><span class="token operator">:</span> <span class="token number">1574245378</span><span class="token punctuation">,</span> <span class="token property">"is_typing"</span><span class="token operator">:</span> <span class="token boolean">true</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span> </code></pre></div></div></div><h4 class="heading"><a id="incoming_sneak_peek" href="#incoming_sneak_peek" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#incoming_sneak_peek"><span class="icon icon-link"></span></a><code>incoming_sneak_peek</code></a></h4><p>Informs about the message a Customer is currently typing. The push payload contains the sneak peek object.</p><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Sample push payload</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"chat_id"</span><span class="token operator">:</span> <span class="token string">"PJ0MRSHTDG"</span><span class="token punctuation">,</span> <span class="token property">"thread_id"</span><span class="token operator">:</span> <span class="token string">"K600PKZON8"</span><span class="token punctuation">,</span> <span class="token property">"sneak_peek"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"author_id"</span><span class="token operator">:</span> <span class="token string">"b7eff798-f8df-4364-8059-649c35c9ed0c"</span><span class="token punctuation">,</span> <span class="token property">"text"</span><span class="token operator">:</span> <span class="token string">"Hello"</span><span class="token punctuation">,</span> <span class="token property">"timestamp"</span><span class="token operator">:</span> <span class="token number">1574245378</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span> </code></pre></div></div></div><h4 class="heading"><a id="events_marked_as_seen" href="#events_marked_as_seen" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#events_marked_as_seen"><span class="icon icon-link"></span></a><code>events_marked_as_seen</code></a></h4><p>Informs that a user has seen events up to a specific time.</p><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Sample push payload</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"user_id"</span><span class="token operator">:</span> <span class="token string">"b7eff798-f8df-4364-8059-649c35c9ed0c"</span><span class="token punctuation">,</span> <span class="token property">"chat_id"</span><span class="token operator">:</span> <span class="token string">"PJ0MRSHTDG"</span><span class="token punctuation">,</span> <span class="token property">"seen_up_to"</span><span class="token operator">:</span> <span class="token string">"2017-10-12T15:19:21.010200Z"</span> <span class="token punctuation">}</span> </code></pre></div></div></div><h4 class="heading"><a id="incoming_multicast" href="#incoming_multicast" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#incoming_multicast"><span class="icon icon-link"></span></a><code>incoming_multicast</code></a></h4><p>Informs about messages sent via the <code>multicast</code> method or by the system.</p><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Sample push payload</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"author_id"</span><span class="token operator">:</span> <span class="token string">"smith@example.com"</span><span class="token punctuation">,</span> <span class="token property">"content"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"example"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"nested"</span><span class="token operator">:</span> <span class="token string">"json"</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"type"</span><span class="token operator">:</span> <span class="token string">"type1"</span> <span class="token punctuation">}</span> </code></pre></div></div></div><h5 class="heading"><a id="push-payload-11" href="#push-payload-11" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#push-payload-11"><span class="icon icon-link"></span></a>Push payload</a></h5><div class="css-q76ucn"><table><thead><tr><th>Field</th><th>Required</th><th>Notes</th></tr></thead><tbody><tr><td><code>author_id</code></td><td>No</td><td>Present only if the push was generated by the <strong>Multicast</strong> method and not sent from the server.</td></tr><tr><td><code>content</code></td><td>Yes</td><td></td></tr><tr><td><code>type</code></td><td>No</td><td></td></tr></tbody></table></div><h4 class="heading"><a id="chat_unfollowed" href="#chat_unfollowed" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#chat_unfollowed"><span class="icon icon-link"></span></a><code>chat_unfollowed</code></a></h4><p>Informs that a chat has been unfollowed. Useful in multiple connection scenarios, where one app/integration needs to know that another one unfollowed the chat.</p><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Sample push payload</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"chat_id"</span><span class="token operator">:</span> <span class="token string">"PJ0MRSHTDG"</span> <span class="token punctuation">}</span> </code></pre></div></div></div><h4 class="heading"><a id="queue_positions_updated" href="#queue_positions_updated" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#queue_positions_updated"><span class="icon icon-link"></span></a><code>queue_positions_updated</code></a></h4><p>New positions and wait times for queued chats.</p><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Sample push payload</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">[</span><span class="token punctuation">{</span> <span class="token property">"chat_id"</span><span class="token operator">:</span> <span class="token string">"PJ0MRSHTDG"</span><span class="token punctuation">,</span> <span class="token property">"thread_id"</span><span class="token operator">:</span> <span class="token string">"K600PKZON8"</span><span class="token punctuation">,</span> <span class="token property">"queue"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"position"</span><span class="token operator">:</span> <span class="token number">42</span><span class="token punctuation">,</span> <span class="token property">"wait_time"</span><span class="token operator">:</span> <span class="token number">1337</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span> <span class="token property">"chat_id"</span><span class="token operator">:</span> <span class="token string">"PJ0VRSATDS"</span><span class="token punctuation">,</span> <span class="token property">"thread_id"</span><span class="token operator">:</span> <span class="token string">"K60QPKSON9"</span><span class="token punctuation">,</span> <span class="token property">"queue"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"position"</span><span class="token operator">:</span> <span class="token number">43</span><span class="token punctuation">,</span> <span class="token property">"wait_time"</span><span class="token operator">:</span> <span class="token number">1373</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span><span class="token punctuation">]</span> </code></pre></div></div></div><h4 class="heading"><a id="customer_unfollowed" href="#customer_unfollowed" class="reference css-180507a"><a href="/docs/messaging/agent-chat-api/rtm-pushes#customer_unfollowed"><span class="icon icon-link"></span></a><code>customer_unfollowed</code></a></h4><p>Informs that a customer was unfollowed. Useful in multiple connection scenarios, where one app/integration needs to know that another one unfollowed the customer.</p><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Sample push payload</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"id"</span><span class="token operator">:</span> <span class="token string">"b7eff798-f8df-4364-8059-649c35c9ed0c"</span> <span class="token punctuation">}</span> </code></pre></div></div></div><style data-emotion-css="1fsewzh">.css-1fsewzh{margin-top:50px;}.css-1fsewzh > label{margin:0 0 5px 0;}.css-1fsewzh label + div{-webkit-box-pack:center;-webkit-justify-content:center;-ms-flex-pack:center;justify-content:center;}</style></article></div><p>...</p></div><style data-emotion-css="1mpu5jj">.css-1mpu5jj{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-box-pack:space-evenly;-webkit-justify-content:space-evenly;-ms-flex-pack:space-evenly;justify-content:space-evenly;-webkit-align-items:start;-webkit-box-align:start;-ms-flex-align:start;align-items:start;-webkit-flex-wrap:wrap;-ms-flex-wrap:wrap;flex-wrap:wrap;background-color:#f6f6f7;color:#424d57;min-height:248px;margin-bottom:45px;}@media (min-width:768px){.css-1mpu5jj{margin-bottom:0px;}}</style><div class="css-1mpu5jj"><style data-emotion-css="dtzkur">.css-dtzkur{width:100%;padding:20px;}@media (min-width:768px){.css-dtzkur{margin-top:75px;padding:0;width:160px;}}</style><div class="css-dtzkur"><style data-emotion-css="r8rj3w">.css-r8rj3w{font-weight:600;font-size:16px;line-height:24px;color:#424d57;}</style><div class="css-r8rj3w">Join the community</div><style data-emotion-css="1ws0nkq">.css-1ws0nkq{font-weight:400;font-size:12px;line-height:20px;color:#424d57;}</style><div class="css-1ws0nkq">Get in direct contact with us through Discord.</div><style data-emotion-css="652pjx">.css-652pjx:hover{-webkit-text-decoration:none;text-decoration:none;}</style><a href="https://discord.gg/MGFyhbdFxt" target="_blank" rel="noopener noreferrer" class="css-652pjx"><style data-emotion-css="y77wuh">.css-y77wuh{margin-top:5px;}</style><button class="lc-btn lc-btn--secondary lc-btn--compact css-y77wuh" type="button"><i class="lc-btn__icon lc-btn__icon-left"><svg width="20" height="16" viewBox="0 0 20 16" fill="none" xmlns="http://www.w3.org/2000/svg"><g clip-path="url(#clip0_613_10386)"><path d="M16.9308 1.63294C15.6561 1.04804 14.2892 0.617109 12.8599 0.370298C12.8339 0.365535 12.8079 0.377439 12.7945 0.401247C12.6187 0.713926 12.4239 1.12184 12.2876 1.44246C10.7503 1.21232 9.22099 1.21232 7.71527 1.44246C7.57887 1.11471 7.37707 0.713926 7.20048 0.401247C7.18707 0.378233 7.16107 0.366329 7.13504 0.370298C5.70659 0.616321 4.33963 1.04725 3.06411 1.63294C3.05307 1.6377 3.04361 1.64564 3.03732 1.65595C0.444493 5.52959 -0.265792 9.30801 0.0826501 13.0396C0.0842267 13.0578 0.0944749 13.0753 0.108665 13.0864C1.81934 14.3427 3.47642 15.1054 5.10273 15.6109C5.12876 15.6188 5.15634 15.6093 5.1729 15.5879C5.55761 15.0625 5.90054 14.5086 6.19456 13.926C6.21192 13.8919 6.19535 13.8514 6.15989 13.838C5.61594 13.6316 5.098 13.38 4.59977 13.0943C4.56037 13.0713 4.55721 13.015 4.59347 12.988C4.69831 12.9094 4.80318 12.8277 4.9033 12.7451C4.92141 12.7301 4.94665 12.7269 4.96794 12.7364C8.24107 14.2308 11.7846 14.2308 15.0191 12.7364C15.0404 12.7261 15.0657 12.7293 15.0846 12.7443C15.1847 12.8269 15.2895 12.9094 15.3952 12.988C15.4314 13.015 15.4291 13.0713 15.3897 13.0943C14.8914 13.3856 14.3735 13.6316 13.8288 13.8372C13.7933 13.8507 13.7775 13.8919 13.7949 13.926C14.0952 14.5078 14.4381 15.0617 14.8157 15.5871C14.8315 15.6093 14.8599 15.6188 14.8859 15.6109C16.5201 15.1054 18.1772 14.3427 19.8879 13.0864C19.9028 13.0753 19.9123 13.0586 19.9139 13.0404C20.3309 8.72626 19.2154 4.97883 16.9568 1.65674C16.9513 1.64564 16.9419 1.6377 16.9308 1.63294ZM6.68335 10.7674C5.69792 10.7674 4.88594 9.86274 4.88594 8.75167C4.88594 7.6406 5.68217 6.7359 6.68335 6.7359C7.69239 6.7359 8.49651 7.64855 8.48073 8.75167C8.48073 9.86274 7.68451 10.7674 6.68335 10.7674ZM13.329 10.7674C12.3435 10.7674 11.5316 9.86274 11.5316 8.75167C11.5316 7.6406 12.3278 6.7359 13.329 6.7359C14.338 6.7359 15.1421 7.64855 15.1264 8.75167C15.1264 9.86274 14.338 10.7674 13.329 10.7674Z" fill="#424D57"></path></g><defs><clipPath id="clip0_613_10386"><rect width="20" height="15.493" fill="white" transform="translate(0 0.25354)"></rect></clipPath></defs></svg></i><div>Discord</div></button></a></div><div class="css-dtzkur"><div class="css-r8rj3w">Follow us</div><div class="css-1ws0nkq">Follow our insightful tweets and interact with our content.</div><a href="https://twitter.com/TextPlatform" target="_blank" rel="noopener noreferrer" class="css-652pjx"><button class="lc-btn lc-btn--secondary lc-btn--compact css-y77wuh" type="button"><i class="lc-btn__icon lc-btn__icon-left"><svg width="24" height="24" class="rmi rmi-twitter undefined" viewBox="0 0 24 24"><path d="M22.46 6c-.77.35-1.6.58-2.46.69.88-.53 1.56-1.37 1.88-2.38-.83.5-1.75.85-2.72 1.05C18.37 4.5 17.26 4 16 4c-2.35 0-4.27 1.92-4.27 4.29 0 .34.04.67.11.98C8.28 9.09 5.11 7.38 3 4.79c-.37.63-.58 1.37-.58 2.15 0 1.49.75 2.81 1.91 3.56-.71 0-1.37-.2-1.95-.5v.03c0 2.08 1.48 3.82 3.44 4.21a4.22 4.22 0 0 1-1.93.07 4.28 4.28 0 0 0 4 2.98 8.521 8.521 0 0 1-5.33 1.84c-.34 0-.68-.02-1.02-.06C3.44 20.29 5.7 21 8.12 21 16 21 20.33 14.46 20.33 8.79c0-.19 0-.37-.01-.56.84-.6 1.56-1.36 2.14-2.23z"></path></svg></i><div>Twitter</div></button></a></div><div class="css-dtzkur"><div class="css-r8rj3w">Contribute</div><div class="css-1ws0nkq">See something that's wrong or unclear? Submit a pull request.</div><a href="https://github.com/livechat/livechat-public-docs" target="_blank" rel="noopener noreferrer" class="css-652pjx"><button class="lc-btn lc-btn--secondary lc-btn--compact css-y77wuh" type="button"><i class="lc-btn__icon lc-btn__icon-left"><svg width="24" height="24" class="rmi rmi-github undefined" viewBox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2z"></path></svg></i><div>GitHub</div></button></a></div><div class="css-dtzkur"><div class="css-r8rj3w">Contact us</div><div class="css-1ws0nkq">Want to share feedback? Reach us at: <a href="mailto:developers@text.com">developers@text.com</a></div></div></div></div><script id="__NEXT_DATA__" type="application/json">{"props":{"pageProps":{}},"page":"/messaging/agent-chat-api/rtm-pushes","query":{},"buildId":"mT926s0W5VyhfFaApGsyO","assetPrefix":"/docs","runtimeConfig":{},"nextExport":true,"autoExport":true,"isFallback":false}</script><script nomodule="" src="/docs/_next/static/chunks/polyfills-c2dc1d9251306528e50c.js"></script><script src="/docs/_next/static/chunks/webpack-af19fbe32e13fc779465.js" async=""></script><script src="/docs/_next/static/chunks/framework.57a22ac5870571c2eff5.js" async=""></script><script src="/docs/_next/static/chunks/commons.0889bf71124535c6c4cd.js" async=""></script><script src="/docs/_next/static/chunks/main-7bb61c4f8d40f1e634e9.js" async=""></script><script src="/docs/_next/static/chunks/pages/_app-cdbe91fdfdbd305577ef.js" async=""></script><script src="/docs/_next/static/chunks/f66b9295.f9eceaafe4216b86326e.js" async=""></script><script src="/docs/_next/static/chunks/b31dc3a52fd33fe1943f491eae223576a0413e10.ac30430b2138b8fefed8.js" async=""></script><script src="/docs/_next/static/chunks/067aff065064306958fa97cea949633bebf95d70.dede6f8249fbb82aff52.js" async=""></script><script src="/docs/_next/static/chunks/pages/messaging/agent-chat-api/rtm-pushes-441c73352c99984f65cc.js" async=""></script><script src="/docs/_next/static/mT926s0W5VyhfFaApGsyO/_buildManifest.js" async=""></script><script src="/docs/_next/static/mT926s0W5VyhfFaApGsyO/_ssgManifest.js" async=""></script></body></html>