Skip to content

Commit 2576090

Browse files
docs: improve https with cdn guide (#821)
* docs: improve https with cdn guide * Update managed-https-for-tracking-domains.md
1 parent edcb410 commit 2576090

6 files changed

Lines changed: 31 additions & 12 deletions

File tree

content/docs/tech-resources/enabling-https-engagement-tracking-on-sparkpost.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -713,19 +713,17 @@ To enable SparkPost to record human-driven repeat opens/clicks, while screening
713713
714714
## Switch tracking domain to secure, and validate
715715
716-
If you have previously created a tracking domain (whether verified or unverified), and wish to switch it from insecure (the default) to secure, use the [Update a Tracking Domain API](https://developers.sparkpost.com/api/tracking-domains/#tracking-domains-put-update-a-tracking-domain) `PUT` call, to update the tracking domain with the `"secure": true` string.
716+
If you have previously created a tracking domain (whether verified or unverified), and wish to switch it from insecure (the default) to secure, follow the steps below:
717717
718-
1. Run the PUT call with the following data:
718+
1. Navigate to the details page of your domain. In the _HTTPS_ section, you will see _HTTPS Disabled_ as the current status.
719719
720-
```
721-
{
722-
"secure" : true
723-
}
724-
```
720+
![](media/enabling-https-engagement-tracking-on-sparkpost/enable_https_cdn.png)
721+
722+
Under _Choose how to enable HTTPS_, select the option _Certificate managed by CDN or reverse proxy (Advanced)_ and then click on _Enable HTTPS_ to proceed. After a page refresh, the section will now show _HTTPS Enabled via self-managed infrastructure_.
725723
726-
Note: If you would like this tracking domain to be the default, please add `"default": true` to the JSON object above, before updating the domain.
724+
![](media/enabling-https-engagement-tracking-on-sparkpost/https_enabled_cdn.png)
727725
728-
Detailed information on this operation can be found in our API documentation [here](https://developers.sparkpost.com/api/tracking-domains.html#tracking-domains-retrieve,-update,-and-delete-put).
726+
Now, the tracking domain is secure.
729727
730728
1. Navigate to the Tracking Domains section in the UI and click the "test" verification button.
731729

content/docs/tech-resources/managed-https-for-tracking-domains.md

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ SparkPost provides different types of tracking endpoints:
6363
| SparkPost US V2 | `v2.spgo.io` | Yes | Yes |
6464
| SparkPost EU V2 | `eu.v2.spgo.io` | Yes | Yes |
6565

66-
**To use managed HTTPS, your tracking domain must use a [V2 endpoint](#tracking-endpoints).** (`v2.spgo.io` for US accounts or `eu.v2.spgo.io` for EU accounts). New tracking domains created after December, 2025, automatically use V2 endpoints.
66+
**To use managed HTTPS, your tracking domain must use a V2 endpoint** (`v2.spgo.io` for US accounts or `eu.v2.spgo.io` for EU accounts). New tracking domains created after December, 2025, automatically use V2 endpoints.
6767

6868
## Enabling Managed HTTPS
6969

@@ -96,9 +96,9 @@ If a tracking domain was not yet configured to use HTTPS, it's possible to do so
9696
9797
1. Navigate to the details page of your insecure domain. In the _HTTPS_ section, you will see _HTTPS Disabled_ as the current status.
9898

99-
![](media/managed-https-for-tracking-domains/insecure_domain_enable.png)
99+
![](media/managed-https-for-tracking-domains/enable_https_managed.png)
100100

101-
Under _Choose how to enable HTTPS_, make sure the default option _SparkPost manages TLS certificate_ is selected. Click on _Enable HTTPS_ to proceed.
101+
Under _Choose how to enable HTTPS_, make sure the default option _Certificate managed by SparkPost (Recommended)_ is selected. Click on _Enable HTTPS_ to proceed.
102102

103103
2. Follow the wizard instructions to verify if the domain supports managed HTTPS.
104104

@@ -163,6 +163,27 @@ Let's Encrypt certificates are valid for 90 days and SparkPost will renew automa
163163

164164
## Troubleshooting
165165

166+
### Testing the managed certificate
167+
168+
You can test that your tracking domain is being secured by a Let's Encrypt certificate with the following command:
169+
170+
```sh
171+
curl -v https://track.yourdomain.com/f/a/b/c/d
172+
```
173+
174+
The output will show the TLS negotiation including info on the certificate served by SparkPost for your domain. Example:
175+
176+
```
177+
* subject: CN=tracking.myboxdemo.space
178+
* start date: Jan 27 19:09:17 2026 GMT
179+
* expire date: Apr 27 19:09:16 2026 GMT
180+
* subjectAltName: host "tracking.myboxdemo.space" matched cert's "tracking.myboxdemo.space"
181+
* issuer: C=US; O=Let's Encrypt; CN=E8
182+
* SSL certificate verify ok.
183+
```
184+
185+
Note: If DNS changes have not fully propagated, this command can instead show the previously used certificate. Try again later.
186+
166187
### Certificate stuck in _Pending_ status
167188

168189
If your certificate remains in Pending status for more than 30 minutes:
169 KB
Loading
83.3 KB
Loading
170 KB
Loading
Binary file not shown.

0 commit comments

Comments
 (0)