A third-party integration guide explains how to use a third-party product with Cloudflare. Because Cloudflare does not control the third party's interface, these guides carry real maintenance risk, so they favor linking to externally maintained documentation over reproducing another product's steps. The tone is instructional and straightforward.
Write a third-party integration guide when a reader needs to connect one specific external product with Cloudflare, and the integration is worth publishing with an ongoing maintenance commitment. It is not:
- A how-to. A how-to documents a task entirely within Cloudflare, whereas an integration guide crosses into a third-party product Cloudflare does not control.
- A blog post. Publish an integration guide only with the expectation of maintenance. If you do not intend to maintain it, write a blog post instead.
For the full comparison, refer to Content types.
- Title: a short verb phrase in the second-person imperative that includes the third-party product name, not a gerund. If the integration is with a Cloudflare technology partner, add the partner component after the title.
- Description: name the third-party product and the Cloudflare product, state what the integration accomplishes, and note the key prerequisites.
Copy this skeleton and adapt it to your integration:
---
title: <Verb phrase naming the third-party product>
description: Connect <third-party product> with <Cloudflare product> to <what the integration accomplishes>.
pcx_content_type: integration-guide
sidebar:
order: 10
products:
- product-a
---
Introduce what the integration accomplishes and any considerations unique to the third party.
## Prerequisites
List what the reader needs on the third-party side before starting.
## Set up the integration
Give the steps that complete the integration, linking to the third party's own documentation rather than reproducing its process.
## Related links
Point to the third party's maintained documentation and the related Cloudflare product docs.- Context introduces what the steps accomplish and any considerations unique to the third party.
- Prerequisites list what the reader needs on the third-party side before starting.
- Steps complete the integration, linking out for basic concepts rather than teaching them.
- Links point to the third party's own documentation, preferred over reproducing its process, and only to reputable sources.
- What does not fit: step-by-step instructions of the third-party product, which are discouraged because they go out of date the moment the third party changes. Screenshots of the third-party product are the most fragile of all, so avoid them and link to the externally maintained source instead.
pcx_content_type: integration-guide
products:
- product-a
- product-bFor more details, refer to pcx_content_type.
Publish a third-party integration guide as post-sales, use-phase content, with the expectation that someone will maintain it. External guides cost more to maintain because Cloudflare does not control the third party's interface and does not get the same visibility into changes. If you want to publish something without that maintenance commitment, write a blog post instead. This content appears most often around Workers, Zero Trust, and Analytics integrations.
Integration handled in the Cloudflare dashboard:
Linking out to external documentation:
Instructions in both the third-party environment and the Cloudflare dashboard, which is discouraged but sometimes acceptable:
- Link, do not reproduce. Point to the third party's own documentation for its steps, because reproduced instructions and screenshots go stale as soon as the external product changes.
- Complete prerequisites. State exactly what the reader needs on the third-party side before starting, because an agent cannot complete an integration it is not set up to reach.
- Name both products. Name the third-party product and the Cloudflare product in the title and context, so a reader or agent can match the guide to the integration they need.