Documentation Menu↓
Deployment
Understanding the Deploy Pipeline
Checking steps from local approval to remote tag rendering.
Difficulty:
|Intermediate
Est: 9 mins
|Updated July 2026
Overview
The Deployment Pipeline is the secure channel through which CrawlSage writes code patches to your live CMS. When you approve an AI SEO recommendation, the system compiles the HTML edits into a payload and transmits it via REST API directly to your connected WordPress or Shopify plugin.
Prerequisites
- An active website integration (e.g. WordPress Plugin connection online).
- At least one approved AI recommendation.
Step-by-Step Guide
- From the **Optimizations** dashboard, locate the recommendation card you want to deploy.
- Review the code diff (current vs. suggested tag) and click **Apply Fix**.
- The fix enters the deployment queue, changing status to Processing.
- CrawlSage signs the patch payload using your workspace credentials and transmits it via HTTP POST to your site's custom REST endpoint.
- The plugin parses the signature, writes the changes to your site's template header database, and returns a successful response code.
- The fix status changes to Applied, triggering the post-deploy verification scheduler.
Expected Result
The recommendation card will update to show a status of Applied. The code patch will be immediately injected into your website's header tag section when subsequent users or search bots load the page.
Patch Signing Integrity
All deployment payloads are signed using private credentials keys specific to your project. Any payloads missing these keys are rejected by the WordPress plugin to prevent spoofing attacks.
Common Mistakes
- Disconnecting the plugin mid-deployment: Deactivating the WordPress plugin or changing your integration key during the deploy lifecycle causes the REST transmission to fail. Keep the plugin active until actions finish.
Troubleshooting
- Deployment fails with status "Connection Timeout":
Verify that your host firewall or CDN proxy rules do not block POST requests to the
/wp-json/crawlsage/v1endpoint range. Whitelist our IPs in your security rules.
Related Guides
Related Guides
Was this page helpful to your workflow?