Contentful setup guide

Agents read and update your website's content.

Ways to connect

Company admins connect apps, on the Integrations page in Everdeck: open Contentful, choose one of the ways below, follow its steps and fill in its fields. Everdeck checks what you enter before it saves anything, and asks you to confirm it’s you (your second factor) before you type any secret. How connecting works.

Contentful can be connected 2 ways. Where there’s a key or token to paste, that’s usually the quickest.

Personal access token

API key.

1. Sign in to the Contentful web app as the user the agent should act as. The token gets exactly that user's rights, so a dedicated user with an Editor role on the space works well (registering webhooks needs a space admin).
2. Open the space, choose Settings > CMA tokens and click Create personal access token.
3. Name it "Everdeck", choose an expiry date, and click Generate. Copy the token (it starts with CFPAT-); it cannot be shown again.
4. Enter the token, the space ID, the environment (usually master) and the data region: EU data residency organizations use the EU option.

Field	What to enter
Personal access token	A secret: Everdeck saves it encrypted and never shows it again. Where to find it.
Space ID	Text. In the web app: Settings > General settings shows the Space ID.
Environment (optional)	Text. Starts as master. For example master. Usually master. Use another environment id (or an alias) to keep the agent away from production.
Data region (optional)	Choice: Default (api.contentful.com), EU data residency (api.eu.contentful.com). Starts as contentful.com.

Disconnecting deletes the credentials Everdeck saved, but Everdeck can't revoke them: the key, token or password itself keeps working at Contentful until you delete or rotate it there.

Your Contentful OAuth app

Your OAuth app.

This way signs in with an OAuth app you create for Contentful, as its steps describe: Everdeck never uses an app of its own. Register this redirect URI with your app:

https://everdeck.io/api/oauth/callback

Then save the app’s client ID and secret in Everdeck, on the connect page or under OAuth apps, and sign in.

1. Open https://app.contentful.com/account/profile/developers/applications (the same path on app.eu.contentful.com for EU data residency) and create an OAuth application.
2. Set the redirect URI to https://everdeck.io/api/oauth/callback, mark the application as confidential, and choose the content_management_manage scope (read and write).
3. Copy the Client ID and Client Secret into the form, enter the space ID, environment and data region, then sign in as the user the agent should act as.

Field	What to enter
Space ID	Text.
Environment (optional)	Text. Starts as master. For example master.
Data region (optional)	Choice: Default (app.contentful.com), EU data residency (app.eu.contentful.com). Starts as contentful.com.

The scopes Everdeck asks for:

• content_management_manage

When you disconnect, Everdeck asks Contentful to revoke the sign-in, then deletes the tokens it saved.

What agents can do

An agent uses an action only when its charter grants it, on the agent’s Tools tab, where you choose whether each one runs by itself (Auto), asks first or never runs. Each action has a risk tier: tier 3 actions, which customers or the public see, ask first unless you choose otherwise, and tier 4 actions (money, deleting things, access) always need a person. How tools and tiers work.

Actions marked Reads outside content return things people outside your company may have written. Agents treat what they read as information, never as instructions, and their riskier actions later in the same session need approval.

• List content typesTier 0 · ReadReads outside contentcontentful_list_content_types

  List the content types (for example Blog Post, Landing Page, Product) with each field's id, type, whether it is required or localized, and its validations. Read this before writing entries.

• List localesTier 0 · ReadReads outside contentcontentful_list_locales

  List the environment's locales (for example en-US, de-DE) and which one is the default. Every field value is keyed by locale code.

• Find entriesTier 0 · ReadReads outside contentcontentful_search_entries

  Search entries by text, content type or change date, most recently updated first. Returns each entry's id, content type, version numbers and fields in every locale. An entry is a draft when publishedVersion is missing, published when version = publishedVersion + 1, and has unpublished changes when version is higher. Archived entries are left out.

• Read an entryTier 0 · ReadReads outside contentcontentful_get_entry

  Read an entry's fields in every locale, its content type, tags and version number. Read it before updating or publishing it; empty fields are not returned.

• Draft an entryTier 2 · ReversibleReads outside contentcontentful_create_entry

  Create a new entry as a draft; nothing changes on the website until it is published. Field values are keyed by field id and then locale code.

• Edit an entryTier 2 · ReversibleReads outside contentcontentful_update_entry

  Change fields of an entry with JSON Patch operations. Saved as a draft change: the published version stays live until the entry is published again. Send the version from get_entry.

• Publish an entry or assetTier 3 · Externalcontentful_publish

  Publish the current version of an entry or asset so the website shows it. Linked entries and assets must be published too, or they will not appear. Send the version from get_entry.

• List comments on an entryTier 0 · ReadReads outside contentcontentful_list_comments

  Read the comment thread on an entry (teammates' review notes); each comment's status is active or resolved.

• Comment on an entryTier 2 · ReversibleReads outside contentcontentful_add_comment

  Leave a comment on an entry for the editorial team, for example a summary of changes made. At most 512 bytes.

• Reply to a commentTier 2 · ReversibleReads outside contentcontentful_reply_to_comment

  Reply in a comment thread on an entry. At most 512 bytes.

• Find images and filesTier 0 · ReadReads outside contentcontentful_search_assets

  Search the media library by text and file type to reuse an existing image in an entry.

• Add an image or fileTier 2 · ReversibleReads outside contentcontentful_create_asset

  Add an image or file to the media library from a public URL or a file in the company's Spaces, with a title and description (used as alt text). It stays unpublished until publish is used.

What can start work

These events from Contentful can become tasks for your agents through Intake. How Intake works.

An entry was created or edited in the environment.

Connect Contentful first. Then, on the Intake page, open Webhooks and sources, find it under Connector triggers and select Start watching. Then, on the Rules tab, select New rule to say which requests become tasks and who gets them.

Testing, problems and disconnecting

Everdeck checks the connection when you save it. On the connection’s page in Integrations, Test checks it again at any time.

If Contentful later refuses the connection, for example because a key was deleted or a sign-in expired, the connection shows Needs attention on the Integrations page and the people who manage connections are told. Agents can’t use it until a company admin fixes it with Edit or Reconnect.

To stop agents using Contentful, open the connection and select Disconnect. Agents stop using it at once and its saved credentials are deleted. What else happens depends on how it was connected: each way above says.