Integrations
Site integration guide
How edits reach your site depends on how the site is built. Start with a test site and test data, and confirm where each change is saved and whether it goes live.
This guide is for developers. If you aren’t one, the setup guide walks you through connecting Google, WordPress and the supported CMSs with screenshots.
Common preparation
The custom site API and the CMS draft jobs need three things: an active Growth or Pro plan, a confirmed ownership check for the site, and the owner’s approval of each edit. Confirm ownership on the Connections screen. Then, on the API screen, create a key that can record results. An API key on its own can’t approve edits.
Map each HTTPS page URL and edit field, one by one, to the CMS record and field that actually appear on that page. Before you set this up, prepare test data, decide who is in charge, and write down how you publish.
Custom-built sites
Build the processing on your site’s server, following the edit API specification. Your server fetches approved edits and checks the URL and field against an allowlist. It saves a draft only when the current value matches the “before” value. Then it reports the saved version and the result back to the API.
The supported edit fields are title, description, h1 and body. For example, you might map the title of https://example.com/about to the title of your own “About us” record. A person checks the draft and publishes it as a separate step.
For step-by-step instructions with screenshots, from creating a key to reporting results and error codes, see Connect your own site with the Get1pct API. For how to store keys and how to turn off a leaked key, see Keep API keys and CMS tokens safe.
WordPress
Connect the site from the Connections screen. You need an application password for a WordPress user who can edit the target posts and pages. Limit that user to the editing permission you need, try the connection on a test page first, and revoke passwords you no longer use. Step-by-step screenshots are in Connect WordPress.
Applying an edit to a published page updates the live content directly. Choosing “Use this edit” is the approval to write. Get1pct can’t create a separate draft. For page builders and fields that can’t be edited, copy the wording and apply it by hand.
CMS draft jobs
If your site runs on Shopify, Webflow, Contentful or microCMS, you can instead connect it in the dashboard, without writing any code. That connection applies title, description and heading edits to the live content. The steps are in the setup guide. The draft jobs below are for teams that want edits saved as unpublished drafts. They fetch edits through the API, so they can’t be used on a site that also has a CMS or WordPress connected in the dashboard (the API refuses with application_conflict).
For Shopify, Webflow, Contentful, Sanity and microCMS, there are sample draft jobs that run on your side. They need Node.js 22.13 or later, and a private SQLite journal on a persistent disk. Pass CMS secrets to them as environment variables from your own server’s secret store. Never put the secrets in the browser, in config files or in logs. Get1pct doesn’t hold your CMS secrets and doesn’t run these jobs for you.
These are test implementations for now. For all five CMSs, saving a draft, reading it back and the result of a rerun were confirmed against the real service, using unpublished content in dedicated test environments. The checks covered only those test items. For Shopify, only the product name was checked; the SEO fields haven’t been tested against the real API.
The example below maps a URL and a Get1pct field to a microCMS endpoint, content ID and field. Replace the values with the ones from your test environment.
{
"projectId": "test-project-id",
"provider": "microcms",
"options": { "serviceId": "example-sandbox" },
"targets": [{
"page": "https://example.com/about",
"field": "title",
"target": {
"endpoint": "draft-fixtures", "id": "about", "field": "title",
"draftKeyEnv": "MICROCMS_DRAFT_KEY_ABOUT"
}
}]
}Every job uses the environment variables GET1PCT_API_ORIGIN, GET1PCT_PROJECT_ID, GET1PCT_API_KEY, GET1PCT_CMS_CONFIG and GET1PCT_CMS_JOURNAL. The credentials for each CMS go in the variables listed in its section below.
Shopify
Create an app in the Dev Dashboard and get a server token with the client credentials grant. Use a development store that doesn’t publish, with an unpublished DRAFT product. Put a token with read_products and write_products in SHOPIFY_INTEGRATION_TOKEN. In the config, specify shop (for example, example.myshopify.com) and productId (for example, gid://shopify/Product/123). title and description map to the SEO fields, and h1 maps to the product name. Body text isn’t supported.
Webflow
Put a token with CMS read and write access for a test site in WEBFLOW_INTEGRATION_TOKEN. Point to an editable PlainText field in the primary locale with collectionId, itemId and fieldSlug, and check that the template actually shows that field. The job saves changes to staging. Publishing is a separate step.
Contentful
In a test space and environment, put a management API token that can read and edit the target entry in CONTENTFUL_INTEGRATION_TOKEN. Specify spaceId, environmentId, entryId, fieldId and locale (for example, en-US). Existing text fields are supported; Rich Text isn’t. If the entry is published, the change stays unpublished until you publish it yourself.
Sanity
In a test dataset, put a token that can read and edit the target draft in SANITY_INTEGRATION_TOKEN. Specify projectId, dataset, an existing documentId that starts with drafts., and a string field. Portable Text isn’t supported. Check the content in Studio, and publish it yourself if you want it live.
microCMS
In a test service, prepare a list API with unpublished content. Put a key limited to GET and PATCH on that API in MICROCMS_INTEGRATION_API_KEY. Put the draft’s draftKey in the environment variable named by draftKeyEnv in the config. Specify serviceId, endpoint, id and a text field. Only existing unpublished content is supported.
Testing and operation
- Using test data, confirm that the URL, field and “before” value match. Then process just one approved edit.
- Check the draft value and version in the CMS admin, and confirm that the live page hasn’t changed. Test direct WordPress updates on a test page.
- Investigate any “before” mismatch or permission error. If you can’t tell whether a save succeeded, run the job again with the same journal so it reads the record back. Don’t resend blindly, and don’t delete the journal.
With Shopify, Webflow and microCMS, the job can’t fully prevent someone else’s edit landing between its final check and its save. While testing, make sure no other person or job edits the same record.