> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Contentful

> How to set up the Contentful connector, plus the actions and events that are available.

![Contentful](https://stackone-logos.com/api/contentful/filled/svg)

v2.0.0[See changelog](https://docs.stackone.com/connectors/contentful/changelog.md)

[82 actions](#actions) · [18 events](#events) · 3 auth methods

CMS
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [Personal Access Token · Connector Profile](https://docs.stackone.com/connectors/contentful/guides/connector-profile/personal-access-token.md)
>
> Best for single-user automation. The token inherits the role permissions of the user who generated it.

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/contentful/guides/connector-profile/oauth-2-0.md)
>
> Delegated access on behalf of the signed-in Contentful user, using an OAuth application registered in Contentful.

> [card] [App Identity · Connector Profile](https://docs.stackone.com/connectors/contentful/guides/connector-profile/app-identity.md)
>
> Requires a custom Contentful app installed in one space environment. Changes are attributed to the app, and access cover...

Optionally, configure receiving Events for Contentful into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/contentful/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [Personal Access Token · Link Account](https://docs.stackone.com/connectors/contentful/guides/link-account/personal-access-token.md)

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/contentful/guides/link-account/oauth-2-0.md)

> [card] [App Identity · Link Account](https://docs.stackone.com/connectors/contentful/guides/link-account/app-identity.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

App Identity

OAuth 2.0

Personal Access Token

No auth methods found

Scopes

Select all
|
Clear

content\_management\_manage

content\_management\_read

No scopes found

82 actions

ActionDescriptionRequired scopes

Get All Assets`contentful_get_all_assets`

List assets in the specified space environment (`master` unless `environment_id` is set). Companion to the \`ContentManag...

`content_management_read`

Get Asset`contentful_get_asset`

Retrieve a single asset by its ID from the specified space environment (`master` unless `environment_id` is set). Use th...

`content_management_read`

Create Asset`contentful_create_asset`

Create a new asset in the specified space environment (`master` unless `environment_id` is set). Fires the \`ContentManag...

`content_management_manage`

Update Asset`contentful_update_asset`

Update an existing asset by ID. Fires the `ContentManagement.Asset.save` webhook. Requires X-Contentful-Version optimist...

`content_management_manage`

Delete Asset`contentful_delete_asset`

Permanently delete an asset by ID. Fires the `ContentManagement.Asset.delete` webhook. Asset MUST be unpublished first —...

`content_management_manage`

Publish Asset`contentful_publish_asset`

Publish an asset so it becomes available on the Content Delivery API. Fires the `ContentManagement.Asset.publish` webhoo...

`content_management_manage`

Unpublish Asset`contentful_unpublish_asset`

Unpublish an asset — its draft is retained but the published version is removed from the Content Delivery API. Fires the...

`content_management_manage`

Process Asset`contentful_process_asset`

Trigger server-side processing of an uploaded asset file for a specific locale. REQUIRED after `create_asset` (or after...

`content_management_manage`

Get All Content Types`contentful_get_all_content_types`

List content types (schemas) in the specified space environment (`master` unless `environment_id` is set). Companion to...

`content_management_read`

Get Content Type`contentful_get_content_type`

Retrieve a single content type by its ID from the specified space environment (`master` unless `environment_id` is set)....

`content_management_read`

Create Content Type`contentful_create_content_type`

Create a content type with a caller-supplied ID (Contentful uses PUT for upsert-by-ID — there is no POST endpoint). Fire...

`content_management_manage`

Update Content Type`contentful_update_content_type`

Update an existing content type. Fires the `ContentManagement.ContentType.save` webhook. Requires X-Contentful-Version o...

`content_management_manage`

Delete Content Type`contentful_delete_content_type`

Permanently delete a content type. Fires the `ContentManagement.ContentType.delete` webhook. Content type MUST be unpubl...

`content_management_manage`

Activate Content Type`contentful_activate_content_type`

Activate (publish) a content type so entries can be authored against it and its schema is exposed on the Content Deliver...

`content_management_manage`

Deactivate Content Type`contentful_deactivate_content_type`

Deactivate (unpublish) a content type. Fires the `ContentManagement.ContentType.unpublish` webhook. Existing entries are...

`content_management_manage`

Get All Entries`contentful_get_all_entries`

List entries in the specified space environment (`master` unless `environment_id` is set). Fires read-only against the C...

`content_management_read`

Get Entry`contentful_get_entry`

Retrieve a single entry by its ID from the specified space environment (`master` unless `environment_id` is set). Use th...

`content_management_read`

Create Entry`contentful_create_entry`

Create a new entry of the given content type in the specified space environment (`master` unless `environment_id` is set...

`content_management_manage`

Update Entry`contentful_update_entry`

Update an existing entry by ID. Fires the `ContentManagement.Entry.save` webhook. Requires the X-Contentful-Version opti...

`content_management_manage`

Delete Entry`contentful_delete_entry`

Permanently delete an entry by ID. Fires the `ContentManagement.Entry.delete` webhook. Entry MUST be unpublished first —...

`content_management_manage`

Publish Entry`contentful_publish_entry`

Publish an entry so it becomes available on the Content Delivery API. Fires the `ContentManagement.Entry.publish` webhoo...

`content_management_manage`

Unpublish Entry`contentful_unpublish_entry`

Unpublish an entry — its draft is retained but the published version is removed from the Content Delivery API. Fires the...

`content_management_manage`

List Environments`contentful_list_environments`

List the environments of a space, including `master` and any sandbox environments. Use the returned `sys.id` as \`environ...

`content_management_read`

Get Environment`contentful_get_environment`

Retrieve a single environment of a space by its ID or alias ID.

`content_management_read`

List Organizations`contentful_list_organizations`

List all organizations the authenticated user has access to.

`content_management_read`

Get Organization`contentful_get_organization`

Get details for a specific organization (admin/owner only).

`content_management_read`

Update Organization`contentful_update_organization`

Update an organization's properties (admin/owner only).

`content_management_manage`

List Organization Memberships`contentful_list_organization_memberships`

List all members of an organization.

`content_management_read`

Get Organization Membership`contentful_get_organization_membership`

Retrieve a single organization membership.

`content_management_read`

Update Organization Membership`contentful_update_organization_membership`

Update an organization member's role.

`content_management_manage`

Delete Organization Membership`contentful_delete_organization_membership`

Remove a user from the organization.

`content_management_manage`

List Organization Periodic Usages`contentful_list_organization_periodic_usages`

List organization-wide periodic usage metrics. Requires the organization-usage feature on the account's plan; non-eligib...

`content_management_read`

List Organization Available Licenses`contentful_list_organization_available_licenses`

List available licenses for the organization.

`content_management_read`

Create Organization Invitation`contentful_create_organization_invitation`

Invite a user to join the organization. The invitee receives an email with an acceptance link.

`content_management_manage`

Get Organization Invitation`contentful_get_organization_invitation`

Retrieve a pending or accepted organization invitation by its identifier.

`content_management_read`

List Personal Access Tokens`contentful_list_personal_access_tokens`

List the authenticated user's personal access tokens.

`content_management_read`

Get Personal Access Token`contentful_get_personal_access_token`

Retrieve metadata for a specific personal access token.

`content_management_read`

Create Personal Access Token`contentful_create_personal_access_token`

Create a new personal access token for the authenticated user.

`content_management_manage`

Revoke Personal Access Token`contentful_revoke_personal_access_token`

Revoke a personal access token, immediately invalidating it.

`content_management_manage`

List Organization Access Tokens`contentful_list_admin_access_tokens`

List all personal access tokens (PATs) with access to a Contentful organization.

`content_management_read`

List Roles`contentful_list_roles`

List all roles in a space.

`content_management_read`

Get Role`contentful_get_role`

Retrieve a single role by ID.

`content_management_read`

Create Role`contentful_create_role`

Create a custom role in a space.

`content_management_manage`

Update Role`contentful_update_role`

Update an existing role.

`content_management_manage`

Delete Role`contentful_delete_role`

Permanently delete a role.

`content_management_manage`

List Space Memberships`contentful_list_space_memberships`

List space-membership records for a space (each item carries the user link, admin flag, and role assignments).

`content_management_read`

Get Space Membership`contentful_get_space_membership`

Retrieve a single space membership by ID.

`content_management_read`

Create Space Membership`contentful_create_space_membership`

Grant an existing organization member access to a space (cannot invite net-new users).

`content_management_manage`

Update Space Membership`contentful_update_space_membership`

Update a space membership's roles or admin status.

`content_management_manage`

Delete Space Membership`contentful_delete_space_membership`

Remove a user from a space.

`content_management_manage`

List Space Members`contentful_list_space_members`

List combined direct and team-derived members of a space.

`content_management_read`

Get Space Member`contentful_get_space_member`

Retrieve a single space member's combined direct and team-derived access.

`content_management_read`

List Spaces`contentful_list_spaces`

List all spaces accessible to the authenticated user.

`content_management_read`

Get Space`contentful_get_space`

Retrieve a single space by ID.

`content_management_read`

Create Space`contentful_create_space`

Create a new space in an organization. Requires the organization to have an available space-creation license; otherwise...

`content_management_manage`

Update Space`contentful_update_space`

Update a space's name.

`content_management_manage`

Delete Space`contentful_delete_space`

Permanently delete a space and all of its resources.

`content_management_manage`

Get Space Add-ons`contentful_get_space_addons`

Get add-on allocations for a space. Requires the space add-ons feature on the account's plan; non-eligible accounts retu...

`content_management_read`

Update Space Add-ons`contentful_update_space_addons`

Update add-on allocations for a space. Requires the space add-ons feature on the account's plan; non-eligible accounts r...

`content_management_manage`

Get Space Eligible Licenses`contentful_get_space_eligible_licenses`

List license options eligible for a space.

`content_management_read`

List Space Periodic Usages`contentful_list_space_periodic_usages`

List per-space periodic usage metrics for an organization. Requires the per-space-usage feature on the account's plan; n...

`content_management_read`

List Teams In Space`contentful_list_teams_in_space`

List Team objects (name, description, member count) that have access to a space. For per-team admin status or role assig...

`content_management_read`

List Organization Teams`contentful_list_organization_teams`

List all teams in an organization.

`content_management_read`

Get Team`contentful_get_team`

Retrieve a single team by ID.

`content_management_read`

Create Team`contentful_create_team`

Create a new team in an organization.

`content_management_manage`

Update Team`contentful_update_team`

Update a team's name and description.

`content_management_manage`

Delete Team`contentful_delete_team`

Delete a team from an organization.

`content_management_manage`

List Team Memberships In Team`contentful_list_team_memberships_in_team`

List members of a team.

`content_management_read`

List Organization Team Memberships`contentful_list_organization_team_memberships`

List all team memberships across the organization.

`content_management_read`

Get Team Membership`contentful_get_team_membership`

Retrieve a single team membership by ID.

`content_management_read`

Create Team Membership`contentful_create_team_membership`

Add an organization member to a team.

`content_management_manage`

Delete Team Membership`contentful_delete_team_membership`

Remove a member from a team.

`content_management_manage`

List Team Space Memberships In Space`contentful_list_team_space_memberships_in_space`

List team-space membership records for a space (each item carries the team link, admin flag, and role assignments).

`content_management_read`

Get Team Space Membership`contentful_get_team_space_membership`

Retrieve a single team space membership by ID.

`content_management_read`

Create Team Space Membership`contentful_create_team_space_membership`

Grant a team access to a space.

`content_management_manage`

Update Team Space Membership`contentful_update_team_space_membership`

Update a team's access to a space.

`content_management_manage`

Delete Team Space Membership`contentful_delete_team_space_membership`

Revoke a team's access to a space.

`content_management_manage`

Get Current User`contentful_get_current_user`

Get the currently authenticated Contentful user.

`content_management_read`

List Space Users`contentful_list_space_users`

List User objects (name, email, avatar, activated state) for everyone with access to a Contentful space. If you need rol...

`content_management_read`

Get Space User`contentful_get_space_user`

Get a single user with access to a Contentful space.

`content_management_read`

List Organization Users`contentful_list_organization_users`

List all users in a Contentful organization.

`content_management_read`

Get Organization User`contentful_get_organization_user`

Get a single user in a Contentful organization.

`content_management_read`

## Events

Tags

Select all
|
Clear

Assets

Content Types

Entries

Health Checks

Webhooks

No tags found

18 events

EventDescriptionTags

Active Check`contentful_active_check`

Returns 200 OK for any Contentful webhook delivery that does not carry a recognised topic.

Health Checks

Entry Published`contentful_webhook_entry_publish`

Fired when a Contentful Entry is published. Retrieve the full entry with get\_entry using the entity\_id (body.sys.id).

EntriesWebhooks

Entry Unpublished`contentful_webhook_entry_unpublish`

Fired when a Contentful Entry is unpublished, removing it from delivery APIs.

EntriesWebhooks

Entry Created`contentful_webhook_entry_create`

Fired when a new Contentful Entry is created in the space (draft state).

EntriesWebhooks

Entry Saved`contentful_webhook_entry_save`

Fired when a Contentful Entry is saved (draft changes persisted but not published).

EntriesWebhooks

Entry Deleted`contentful_webhook_entry_delete`

Fired when a Contentful Entry is permanently deleted from the space.

EntriesWebhooks

Entry Auto-Saved`contentful_webhook_entry_auto_save`

Fired when a Contentful Entry is automatically saved by the web app editor.

EntriesWebhooks

Asset Published`contentful_webhook_asset_publish`

Fired when a Contentful Asset is published and available via the Delivery API.

AssetsWebhooks

Asset Unpublished`contentful_webhook_asset_unpublish`

Fired when a Contentful Asset is unpublished, removing it from the Delivery API.

AssetsWebhooks

Asset Created`contentful_webhook_asset_create`

Fired when a new Contentful Asset is created in the space.

AssetsWebhooks

Asset Saved`contentful_webhook_asset_save`

Fired when a Contentful Asset is saved (e.g. title or file updated but not yet published).

AssetsWebhooks

Asset Deleted`contentful_webhook_asset_delete`

Fired when a Contentful Asset is permanently deleted from the space.

AssetsWebhooks

Asset Auto-Saved`contentful_webhook_asset_auto_save`

Fired when a Contentful Asset is automatically saved by the web app editor.

AssetsWebhooks

Content Type Published`contentful_webhook_content_type_publish`

Fired when a Contentful Content Type is published, making it available for creating entries.

Content TypesWebhooks

Content Type Unpublished`contentful_webhook_content_type_unpublish`

Fired when a Contentful Content Type is unpublished (new entries can no longer be created from it).

Content TypesWebhooks

Content Type Created`contentful_webhook_content_type_create`

Fired when a new Contentful Content Type is created in the space.

Content TypesWebhooks

Content Type Saved`contentful_webhook_content_type_save`

Fired when a Contentful Content Type's schema is saved (field changes persisted but not yet published).

Content TypesWebhooks

Content Type Deleted`contentful_webhook_content_type_delete`

Fired when a Contentful Content Type is permanently deleted from the space.

Content TypesWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.