{"id":41,"date":"2026-09-09T04:25:56","date_gmt":"2026-09-09T04:25:56","guid":{"rendered":"https:\/\/nirohelp.com\/docs\/41\/embedding-the-ticket-ui\/"},"modified":"2026-09-09T04:25:56","modified_gmt":"2026-09-09T04:25:56","slug":"embedding-the-ticket-ui","status":"publish","type":"nirohelp_doc","link":"https:\/\/nirohelp.com\/docs\/developers\/embedding-the-ticket-ui\/","title":{"rendered":"Embedding the ticket form on another site"},"content":{"rendered":"

NiroHelp serves a self-contained “Need Help?” ticket widget from
\n\/nirohelp\/tickets\/embed\/<\/code>. It is a JavaScript file, not a page<\/strong> \u2014 the
\nendpoint responds with Content-Type: application\/javascript<\/code>, so you load it
\nwith a <script><\/code> tag, not an iframe.<\/p>\n

The widget adds a floating launcher to the host page and opens a new-ticket
\nform. It is a submission surface only: there is no login, no ticket list and no
\nconversation thread inside it. For those, use the shortcodes on your own site.<\/p>\n

The snippet<\/h2>\n
<script src="https:\/\/help.example.com\/nirohelp\/tickets\/embed\/" defer><\/script>\n<\/code><\/pre>\n
The trailing slash matters \u2014 \/nirohelp\/tickets\/embed<\/code> (no slash) answers with
\na 301 to the slashed form, which a <script src><\/code> does follow, but the rewrite
\nrule the plugin registers is ^nirohelp\/tickets\/embed\/?$<\/code>, so link the canonical
\nURL.<\/p>\n
Drop it on any page on any site, WordPress or not.<\/p>\n
What the visitor sees<\/h2>\n
A pill-shaped Need Help?<\/strong> button pinned to the bottom-right of the page.
\nClicking it opens a panel containing:<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n
Field<\/th>\nRequired<\/th>\nNotes<\/th>\n<\/tr>\n<\/thead>\n
Your Name<\/td>\nyes<\/td>\nUsed for the client account and for ##client_name##<\/code>.<\/td>\n<\/tr>\n
Your Email<\/td>\nyes<\/td>\nResolves to an existing account, or creates one.<\/td>\n<\/tr>\n
Subject<\/td>\nyes<\/td>\nBecomes the ticket title.<\/td>\n<\/tr>\n
Description<\/td>\nyes<\/td>\nBecomes the ticket body.<\/td>\n<\/tr>\n
Product<\/td>\nno<\/td>\nPopulated from GET \/tickets\/products\/<\/code>.<\/td>\n<\/tr>\n
Reason<\/td>\nno<\/td>\nPopulated from GET \/tickets\/reasons\/<\/code>.<\/td>\n<\/tr>\n
Urgency<\/td>\nno<\/td>\nPopulated from GET \/tickets\/urgencies\/<\/code>.<\/td>\n<\/tr>\n
Order ID<\/td>\nno<\/td>\nStored as the order<\/code> post meta.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Submitting posts to POST \/wp-json\/nirohelp\/v1\/tickets\/<\/code> on the site that
\nserved the script. That route is deliberately open to anonymous callers \u2014 the
\nwidget runs cross-origin and cannot carry a wp_rest<\/code> nonce \u2014 and hardened
\ninside the callback instead: an anonymous caller can never set user_id<\/code>, so a
\nticket is always filed against the account resolved from the submitted email.<\/p>\n
Where the site URL comes from<\/h2>\n
The endpoint prints one line ahead of the static file:<\/p>\n
var NIROHELP_HOME_URL = "https:\/\/help.example.com";\n<\/code><\/pre>\n
That is what the widget calls. If you serve the script some other way (copying
\nassets\/tickets\/js\/embed.js<\/code> to a CDN, say), the script falls back to slicing
\nits own src<\/code> at \/wp-content\/<\/code> or \/nirohelp\/tickets\/embed<\/code>, and finally to
\nwindow.location.origin<\/code>. Loading it from a third host without either marker in
\nthe path will point it at the wrong site.<\/p>\n
Account creation is a prerequisite<\/h2>\n
A submission from an email with no matching WordPress user only succeeds when
\naccount creation is allowed \u2014 core’s Anyone can register<\/strong>, or NiroHelp ->
\nSettings -> Tickets -> Submission -> Create accounts for new clients<\/strong>. With
\nboth off, the widget can only accept tickets from people who already have an
\naccount on the help site.<\/p>\n
How it differs from the shortcodes<\/h2>\n\n\n\n\n\n\n\n\n\n
<\/th>\nEmbed widget<\/th>\n[nirohelp_new_ticket]<\/code><\/th>\n<\/tr>\n<\/thead>\n
Runs on<\/td>\nany site<\/td>\nthe WordPress site hosting NiroHelp<\/td>\n<\/tr>\n
Rendering<\/td>\ninjected by JS, ignores your theme<\/td>\ninside your theme<\/td>\n<\/tr>\n
Fields<\/td>\nfixed set above<\/td>\ndriven by Settings -> Tickets -> Form fields<\/strong>, custom fields included<\/td>\n<\/tr>\n
Login<\/td>\nnone; identifies by email<\/td>\nlogin required, honours the configured login method<\/td>\n<\/tr>\n
Reading replies<\/td>\nnot possible<\/td>\nvia [nirohelp_tickets]<\/code> and the emailed login link<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
The widget is the “let people file a ticket from our marketing site” surface.
\nClients still read and answer their tickets on the help site, through the link
\nin the notification email.<\/p>\n
Styling it<\/h2>\n
The widget writes inline styles and has no configuration attributes. To change
\nits appearance, copy assets\/tickets\/js\/embed.js<\/code> into your own theme or
\nplugin, edit it there, and enqueue your copy instead of the endpoint. Keep
\nNIROHELP_HOME_URL<\/code> defined ahead of it, or leave the file at a path containing
\n\/wp-content\/<\/code> so the fallback resolves.<\/p>\n
Disabling the endpoint<\/h2>\n
The rewrite rule is registered unconditionally. To take the endpoint offline
\nwithout editing the plugin, short-circuit it before template_include<\/code> runs:<\/p>\n
add_action( 'template_redirect', function () {\n    if ( get_query_var( 'nirohelp_tickets_embed' ) ) {\n        status_header( 404 );\n        exit;\n    }\n}, 5 );\n<\/code><\/pre>\n","protected":false},"author":1,"featured_media":0,"template":"","meta":{"site-sidebar-layout":"default","site-content-layout":"","ast-site-content-layout":"default","site-content-style":"default","site-sidebar-style":"default","ast-global-header-display":"","ast-banner-title-visibility":"","ast-main-header-display":"","ast-hfb-above-header-display":"","ast-hfb-below-header-display":"","ast-hfb-mobile-header-display":"","site-post-title":"","ast-breadcrumbs-content":"","ast-featured-img":"","footer-sml-layout":"","ast-disable-related-posts":"","theme-transparent-header-meta":"","adv-header-id-meta":"","stick-header-meta":"","header-above-stick-meta":"","header-main-stick-meta":"","header-below-stick-meta":"","astra-migrate-meta-layouts":"default","ast-page-background-enabled":"default","ast-page-background-meta":{"desktop":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"tablet":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"mobile":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""}},"ast-content-background-meta":{"desktop":{"background-color":"var(--ast-global-color-4)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"tablet":{"background-color":"var(--ast-global-color-4)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"mobile":{"background-color":"var(--ast-global-color-4)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""}}},"nirohelp_product":[],"nirohelp_topic":[12],"class_list":["post-41","nirohelp_doc","type-nirohelp_doc","status-publish","hentry","nirohelp_topic-developers"],"_links":{"self":[{"href":"https:\/\/nirohelp.com\/docs\/wp-json\/wp\/v2\/nirohelp_doc\/41","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/nirohelp.com\/docs\/wp-json\/wp\/v2\/nirohelp_doc"}],"about":[{"href":"https:\/\/nirohelp.com\/docs\/wp-json\/wp\/v2\/types\/nirohelp_doc"}],"author":[{"embeddable":true,"href":"https:\/\/nirohelp.com\/docs\/wp-json\/wp\/v2\/users\/1"}],"wp:attachment":[{"href":"https:\/\/nirohelp.com\/docs\/wp-json\/wp\/v2\/media?parent=41"}],"wp:term":[{"taxonomy":"nirohelp_product","embeddable":true,"href":"https:\/\/nirohelp.com\/docs\/wp-json\/wp\/v2\/nirohelp_product?post=41"},{"taxonomy":"nirohelp_topic","embeddable":true,"href":"https:\/\/nirohelp.com\/docs\/wp-json\/wp\/v2\/nirohelp_topic?post=41"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}