Host Appcues SDK Under Your Own Domain
Learn about hosting the Appcues SDK under your own domain to avoid Ad Blockers.
Table of Contents
If you want the Appcues Javascript SDK to be served from domains that you control, you can host the Appcues SDK under your own domain. To perform these steps, you will need to configure a CNAME record using your domain's management tools to point to our infrastructure. After that work is done, Appcues will issue an SSL certificate, and then serve the Appcues SDK from this domain instead of from Appcues' domain.
You will need:
- Your Appcues account ID
- You or someone will need administrative access to the custom domain you want to host the SDK from
Setup Instructions:
- Create your desired domain name (such as
apc.example.com
or anything else) as a CNAME record. Point your domain to{account-id}.custom-domains.appcues.com
. At this point that domain won't exist, but Appcues will create it in step 2: - Provide your account ID and domain name you created in step 1 to your Appcues team. They will send this to our DevOps team, who will set up the infrastructure on the Appcues side.
- Appcues will contact Fastly for an authorization record that you will need to add to your top-level domain. Appcues must get this code from Fastly so there is generally a 4 hour delay in response. Once the code is obtained, we will communicate it back to you and you will need to add a DNS TXT record on your top-level domain.
- For example, if you were trying to use
appcues.example.xyz
, you would need to add the record on theexample.xyz
domain record.
- For example, if you were trying to use
- Once that's done and Fastly verifies the record, Appcues will create the custom domain at Fastly. We will accomplish this as soon as possible, which is typically within five business days.
- After Appcues responds that the infrastructure has been set up: Visit
https://apc.example.com/{account-id}.js
(replacingapc.example.com
with the domain you created in step 1) and see that your Javascript SDK is being served from your domain with a valid SSL certificate. - Finally, update your Appcues installation script on your site by replacing
fast.appcues.com
in the script below with the domain you created in step 1. That's it!
For example, your installation script may look something like this:
<script src="//fast.appcues.com/12345.js"></script>
<script>
window.Appcues.identify("<<< USER_ID >>>", // unique, required
{
// user properties...
} );
</script>
and after the change your script would look like the following (replacing abc.example.com
with the domain you created in step 1)
<script src="//apc.example.com/12345.js"></script>
<script>
window.Appcues.identify("<<< USER_ID >>>", // unique, required
{
// user properties...
} );
</script>
After Setup:
Please email support@appcues.com with
- Your account id
- What domain you will be using on your side.
Once sent to us, we'll get your account squared away on our side as soon as possible, typically within five business days.