Customising your Dynamic eConsult banner

There are several ways you can change your dynamic banner

Laura Perring avatar
Written by Laura Perring
Updated over a week ago

This article covers:


Your practice uses a dynamic banner if the eConsult banner on your website looks like this:


Display the dynamic banner without an overlay

Set the overlay parameter to false — or remove it entirely. The snippet below will create a banner without the overlay.

<!-- eConsult banner code START --> <script type="text/javascript"> var eConsultHost = (("https:" == document.location.protocol) ? "https" : "http"); document.write(decodeURIComponent("%3Cscript src='" + eConsultHost + "://s3.eu-west-2.amazonaws.com/cdn.econsult.health/banner/embeddedBanner-2.0.js' type='text/javascript'%3E%3C/script%3E")); </script> <div id="eConsultDefaultTarget"></div> <script language="javascript"> var eConsultParams = {overlay: false}; showBanner(eConsultParams); </script> <!-- eConsult banner code END -->

Change where your eConsult banner appears

Use the target parameter to specify the ID of the banner’s parent element. In the example below, the banner will appear immediately within the #contentMain element.

<!-- eConsult banner code START --> <script type="text/javascript"> var eConsultHost = (("https:" == document.location.protocol) ? "https" : "http"); document.write(decodeURIComponent("%3Cscript src='" + eConsultHost + "://s3.eu-west-2.amazonaws.com/cdn.econsult.health/banner/embeddedBanner-2.0.js' type='text/javascript'%3E%3C/script%3E")); </script> <div id="eConsultDefaultTarget"></div> <script language="javascript"> var eConsultParams = { overlay: true, target: 'contentMain' }; showBanner(eConsultParams); </script> <!-- eConsult banner code END -->

Change the banner heading text

Use the heading parameter to customise the “Contact our doctors online” text of the main banner header.

<!-- eConsult banner code START --> <script type="text/javascript"> var eConsultHost = (("https:" == document.location.protocol) ? "https" : "http"); document.write(decodeURIComponent("%3Cscript src='" + eConsultHost + "://s3.eu-west-2.amazonaws.com/cdn.econsult.health/banner/embeddedBanner-2.0.js' type='text/javascript'%3E%3C/script%3E")); </script> <div id="eConsultDefaultTarget"></div> <script language="javascript"> var eConsultParams = { overlay: true, heading: 'Try something new - contact us online!' }; showBanner(eConsultParams); </script> <!-- eConsult banner code END -->

Change the main strapline

Use the strapline parameter to customise the following text: “Fill out a simple online form to get advice and treatment within 1 working day”.

<!-- eConsult banner code START --> <script type="text/javascript"> var eConsultHost = (("https:" == document.location.protocol) ? "https" : "http"); document.write(decodeURIComponent("%3Cscript src='" + eConsultHost + "://s3.eu-west-2.amazonaws.com/cdn.econsult.health/banner/embeddedBanner-2.0.js' type='text/javascript'%3E%3C/script%3E")); </script> <div id="eConsultDefaultTarget"></div> <script language="javascript"> var eConsultParams = { overlay: true, strapline: 'This great new service is now available to all registered patients' }; showBanner(eConsultParams); </script> <!-- eConsult banner code END -->

Toggle the common condition list

Set the displayConditionList parameter to false to hide the list of common conditions.

<!-- eConsult banner code START --> <script type="text/javascript"> var eConsultHost = (("https:" == document.location.protocol) ? "https" : "http"); document.write(decodeURIComponent("%3Cscript src='" + eConsultHost + "://s3.eu-west-2.amazonaws.com/cdn.econsult.health/banner/embeddedBanner-2.0.js' type='text/javascript'%3E%3C/script%3E")); </script> <div id="eConsultDefaultTarget"></div> <script language="javascript"> var eConsultParams = { overlay: true, displayConditionList: false }; showBanner(eConsultParams); </script> <!-- eConsult banner code END -->

Custom branding

You have the option to customise the eConsult banner by supplying your own CSS. Contact us for more details.


Custom eConsult ID

In almost all cases the eConsult banner script will use the practice website address (origin domain) to find a matching eConsult record and display the banner dynamically.

However, in some rare cases, you may need to include the bannerId parameter with the script to get the banner to display. For example, you’ll need the parameter if you wish to try out the banner on a test site; or you have multiple practice websites pointing to a single eConsult site.

Your bannerId parameter must be the same as your eConsult URL prefix (e.g. “myclinic” in “myclinic.webgp.com”).

Contact us if you have any trouble getting the banner to display in those instances.

<!-- eConsult banner code START --> <script type="text/javascript"> var eConsultHost = (("https:" == document.location.protocol) ? "https" : "http"); document.write(decodeURIComponent("%3Cscript src='" + eConsultHost + "://s3.eu-west-2.amazonaws.com/cdn.econsult.health/banner/embeddedBanner-2.0.js' type='text/javascript'%3E%3C/script%3E")); </script> <div id="eConsultDefaultTarget"></div> <script language="javascript"> var eConsultParams = { overlay: true, bannerId: 'myclinic' }; showBanner(eConsultParams); </script> <!-- eConsult banner code END -->

Running the banner in demo mode

If you add the eConsult banner code to your site before your eConsult site has launched, your banner will automatically display a “Coming soon” message. However, in those instances, you may wish to test the full banner before your eConsult site goes live. To test the full banner before your site goes live, set the bannerId parameter to “DEMO_MODE”.

<!-- eConsult banner code START --> <script type="text/javascript"> var eConsultHost = (("https:" == document.location.protocol) ? "https" : "http"); document.write(decodeURIComponent("%3Cscript src='" + eConsultHost + "://s3.eu-west-2.amazonaws.com/cdn.econsult.health/banner/embeddedBanner-2.0.js' type='text/javascript'%3E%3C/script%3E")); </script> <div id="eConsultDefaultTarget"></div> <script language="javascript"> var eConsultParams = { overlay: true, bannerId: 'DEMO_MODE' }; showBanner(eConsultParams); </script> <!-- eConsult banner code END -->


If you have any questions or you feel that this article could be improved, please feel free to give us some feedback by emailing us, pressing the emojis below or using the chat button on the bottom right-hand side of this page to speak to one of the eConsult team.

Did this answer your question?