Skip to main content

Contentful Component

Manage spaces, environments, entries, assets, and organizations in Contentful

Component key: contentful · Changelog ↓

Description​

Contentful is a content management system (CMS) that allows developers to manage and deliver content across multiple platforms and devices.

The Contentful component allows managing spaces, environments, content types, entries, assets, organizations, webhooks, and bulk actions.

API Documentation​

This component was built using the Contentful Content Management API Reference.

Connections​

OAuth 2.0​

key: contentfulOauth2Connection

To connect to Contentful, create a new OAuth application.

Prerequisites​

  • A Contentful account with developer access

Setup Steps​

  1. Navigate to the Developer Account Settings for OAuth applications
  2. Click Create New Application
  3. Enter the Redirect URI as https://oauth2.prismatic.io/callback
  4. Select Confidential for the client type
  5. Select the applicable scope (e.g., Content management manage)
  6. Save the application
  7. Copy the Client ID and Client Secret
Single Scope Requirement

Contentful only accepts a single scope per authorization request. The content_management_manage scope includes read access, so a separate content_management_read scope is not needed.

Available Scopes​

ScopeDescription
content_management_manageManage and read content in all Spaces
content_management_readRead content in all Spaces

Configure the Connection​

Create a connection of type OAuth 2.0 and enter:

  • Client ID: Enter the Client ID from the OAuth application
  • Client Secret: Enter the Client Secret from the OAuth application
  • Scopes: Enter a single scope (e.g., content_management_manage)
InputNotesExample
Authorize URL

The OAuth 2.0 Authorization URL for Contentful authentication.

https://be.contentful.com/oauth/authorize
Client ID

The Client ID from the OAuth application credentials.

Client Secret

The Client Secret from the OAuth application credentials.

Scopes

A single OAuth 2.0 scope. Contentful accepts one scope per authorization. Valid values: content_management_manage, content_management_read. The manage scope includes read access.

content_management_manage
Token URL

The OAuth 2.0 Token URL for Contentful token exchange.

https://be.contentful.com/oauth/token

Triggers​

Event Subscription​

Receive event notifications from Contentful. Automatically creates and manages a webhook subscription for selected topics when the instance is deployed, and removes the subscription when the instance is deleted. | key: eventsTrigger

InputNotesExample
Connection

The Contentful connection to use.

Space ID

The unique identifier for the Contentful space.

yadj1kx9rmg0
Events

The event types to subscribe to for this webhook.

Entry.create

The Event Subscription trigger receives event notifications from Contentful. It automatically creates and manages a webhook subscription for the selected topics when an instance is deployed, and removes the subscription when the instance is deleted.

How It Works​

When this trigger is used in a flow:

  • On Instance Deploy: The trigger automatically creates a webhook in Contentful configured to send events to the instance's unique webhook URL.
  • On Instance Deletion: The trigger automatically removes the corresponding webhook from Contentful.

The trigger fires each time Contentful sends a matching event notification to the webhook endpoint.

Configuration​

  • Connection: The Contentful OAuth 2.0 connection to use for authentication.
  • Space ID: The unique identifier of the Contentful space to subscribe to.
  • Events: The event types to subscribe to (e.g., Entry.publish, Asset.create).

Event Types​

Available Events (43)
EventDescription
ContentType.createA content type is created
ContentType.saveA content type is saved
ContentType.publishA content type is published
ContentType.unpublishA content type is unpublished
ContentType.deleteA content type is deleted
ContentType.*All content type events
Entry.createAn entry is created
Entry.saveAn entry is saved
Entry.auto_saveAn entry is auto-saved
Entry.archiveAn entry is archived
Entry.unarchiveAn entry is unarchived
Entry.publishAn entry is published
Entry.unpublishAn entry is unpublished
Entry.deleteAn entry is deleted
Entry.*All entry events
Asset.createAn asset is created
Asset.saveAn asset is saved
Asset.auto_saveAn asset is auto-saved
Asset.archiveAn asset is archived
Asset.unarchiveAn asset is unarchived
Asset.publishAn asset is published
Asset.unpublishAn asset is unpublished
Asset.deleteAn asset is deleted
Asset.*All asset events
Task.createA task is created
Task.saveA task is saved
Task.deleteA task is deleted
Task.*All task events
Comment.createA comment is created
Comment.deleteA comment is deleted
Comment.*All comment events
Release.createA release is created
Release.saveA release is saved
Release.archiveA release is archived
Release.unarchiveA release is unarchived
Release.deleteA release is deleted
Release.*All release events
Workflow.createA workflow is created
Workflow.saveA workflow is saved
Workflow.completeA workflow is completed
Workflow.*All workflow events
TemplateInstallation.completeA template installation is completed
TemplateInstallation.*All template installation events
BulkAction.createA bulk action is created
BulkAction.executeA bulk action is executed
BulkAction.*All bulk action events
ReleaseAction.createA release action is created
ReleaseAction.executeA release action is executed
ReleaseAction.*All release action events
ScheduledAction.createA scheduled action is created
ScheduledAction.executeA scheduled action is executed
ScheduledAction.saveA scheduled action is saved
ScheduledAction.deleteA scheduled action is deleted
ScheduledAction.*All scheduled action events

Refer to the Contentful Webhook documentation for the complete and up-to-date list of available events.

Returned Data​

Example Payload
{
  "sys": {
    "type": "Entry",
    "id": "exampleEntryId",
    "space": {
      "sys": {
        "type": "Link",
        "linkType": "Space",
        "id": "exampleSpaceId"
      }
    },
    "environment": {
      "sys": {
        "type": "Link",
        "linkType": "Environment",
        "id": "master"
      }
    },
    "contentType": {
      "sys": {
        "type": "Link",
        "linkType": "ContentType",
        "id": "blogPost"
      }
    },
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-01-15T10:30:00.000Z",
    "publishedAt": "2024-01-15T10:30:00.000Z",
    "revision": 1
  },
  "fields": {
    "title": {
      "en-US": "Hello, World!"
    },
    "body": {
      "en-US": "Example content body."
    }
  }
}

Webhook​

Receive and validate webhook requests from Contentful for webhooks you configure. | key: webhook

InputNotesExample
Connection

The Contentful connection to use.

Data Sources​

Select Asset​

Select an asset from a dropdown menu. | key: selectAsset | type: picklist

InputNotesExample
Connection

The Contentful connection to use.

Environment ID

The unique identifier for the Contentful environment.

staging
Space ID

The unique identifier for the Contentful space.

yadj1kx9rmg0

{
  "result": [
    {
      "label": "Playsam Streamliner",
      "key": "wtrHxeu3zEoEce2MokCSi"
    }
  ]
}

Select Content Type​

Select a content type from a dropdown menu. | key: selectContentType | type: picklist

InputNotesExample
Connection

The Contentful connection to use.

Data Source Return

The field to return from the data source selection (name or ID).

id
Environment ID

The unique identifier for the Contentful environment.

staging
Space ID

The unique identifier for the Contentful space.

yadj1kx9rmg0

{
  "result": [
    {
      "label": "Blog Post",
      "key": "3ORKIAOaJqQWWg86MWkyOs"
    }
  ]
}

Select Entry​

Select an entry from a dropdown menu. | key: selectEntry | type: picklist

InputNotesExample
Connection

The Contentful connection to use.

Environment ID

The unique identifier for the Contentful environment.

staging
Space ID

The unique identifier for the Contentful space.

yadj1kx9rmg0

{
  "result": [
    {
      "label": "Hello, World!",
      "key": "5KsDBWseXY6QegucYAoacS"
    }
  ]
}

Select Environment​

Select an environment from a dropdown menu. | key: selectEnvironment | type: picklist

InputNotesExample
Connection

The Contentful connection to use.

Data Source Return

The field to return from the data source selection (name or ID).

id
Space ID

The unique identifier for the Contentful space.

yadj1kx9rmg0

Select Organization​

Select an organization from a dropdown menu. | key: selectOrganization | type: picklist

InputNotesExample
Connection

The Contentful connection to use.

Data Source Return

The field to return from the data source selection (name or ID).

id

Select Space​

Select a space from a dropdown menu. | key: selectSpace | type: picklist

InputNotesExample
Connection

The Contentful connection to use.

Data Source Return

The field to return from the data source selection (name or ID).

id

Select Webhook​

Select a webhook from a dropdown menu. | key: selectWebhook | type: picklist

InputNotesExample
Connection

The Contentful connection to use.

Space ID

The unique identifier for the Contentful space.

yadj1kx9rmg0

{
  "result": [
    {
      "label": "My webhook",
      "key": "0KzM2HxYr5O1pZ4SaUzK8h"
    }
  ]
}

Actions​

Archive Entry​

Archives an existing entry. | key: archiveEntry

InputNotesExample
Connection

The Contentful connection to use.

Entry ID

The unique identifier for the entry.

5KsDBWseXY6QegucYAoacS
Environment ID

The unique identifier for the Contentful environment.

staging
Space ID

The unique identifier for the Contentful space.

yadj1kx9rmg0

{
  "data": {
    "fields": {
      "title": {
        "en-US": "Hello, World!"
      },
      "body": {
        "en-US": "Bacon is healthy!"
      }
    },
    "metadata": {
      "tags": [
        {
          "sys": {
            "type": "Link",
            "linkType": "Tag",
            "id": "nyCampaign"
          }
        }
      ]
    },
    "sys": {
      "id": "5KsDBWseXY6QegucYAoacS",
      "type": "Entry",
      "contentType": {
        "sys": {
          "type": "Link",
          "linkType": "ContentType",
          "id": "hfM9RCJIk0wIm06WkEOQY"
        }
      },
      "version": 1,
      "space": {
        "sys": {
          "type": "Link",
          "linkType": "Space",
          "id": "yadj1kx9rmg0"
        }
      },
      "environment": {
        "sys": {
          "type": "Link",
          "linkType": "Environment",
          "id": "staging"
        }
      },
      "createdAt": "2015-05-18T11:29:46.809Z",
      "createdBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "7BslKh9TdKGOK41VmLDjFZ"
        }
      },
      "updatedAt": "2015-05-18T11:29:46.809Z",
      "updatedBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "4FLrUHftHW3v2BLi9fzfjU"
        }
      }
    }
  }
}

Create Asset​

Creates a new asset. | key: createAsset

InputNotesExample
Connection

The Contentful connection to use.

Description

The description of the asset as a JSON object with locale keys.

Environment ID

The unique identifier for the Contentful environment.

staging
File

The file metadata for the asset as a JSON object with locale keys and upload details.

Space ID

The unique identifier for the Contentful space.

yadj1kx9rmg0
Title

The title of the asset as a JSON object with locale keys.

{
  "data": {
    "fields": {
      "title": {
        "en-US": "Playsam Streamliner"
      },
      "file": {
        "en-US": {
          "contentType": "image/jpeg",
          "fileName": "example.jpeg",
          "upload": "https://example.com/example.jpg"
        }
      }
    },
    "metadata": {
      "tags": [
        {
          "sys": {
            "type": "Link",
            "linkType": "Tag",
            "id": "nyCampaign"
          }
        }
      ]
    },
    "sys": {
      "id": "wtrHxeu3zEoEce2MokCSi",
      "type": "Asset",
      "version": 1,
      "space": {
        "sys": {
          "type": "Link",
          "linkType": "Space",
          "id": "yadj1kx9rmg0"
        }
      },
      "environment": {
        "sys": {
          "type": "Link",
          "linkType": "Environment",
          "id": "staging"
        }
      },
      "createdAt": "2015-05-18T11:29:46.809Z",
      "createdBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "7BslKh9TdKGOK41VmLDjFZ"
        }
      },
      "updatedAt": "2015-05-18T11:29:46.809Z",
      "updatedBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "4FLrUHftHW3v2BLi9fzfjU"
        }
      }
    }
  }
}

Create Content Type​

Creates a new content type. | key: createContentType

InputNotesExample
Connection

The Contentful connection to use.

Description

A brief explanation of what this content type is used for in the content model.

A blog post
Display Field

The field used as the main display field for entries of this content type.

title
Environment ID

The unique identifier for the Contentful environment.

staging
Content Type Fields

The field definitions for the content type as a JSON array of field objects.

Content Type Name

The display name for the content type.

Blog Post
Space ID

The unique identifier for the Contentful space.

yadj1kx9rmg0

{
  "data": {
    "sys": {
      "type": "ContentType",
      "id": "3ORKIAOaJqQWWg86MWkyOs",
      "version": 1,
      "space": {
        "sys": {
          "type": "Link",
          "linkType": "Space",
          "id": "yadj1kx9rmg0"
        }
      },
      "environment": {
        "sys": {
          "type": "Link",
          "linkType": "Environment",
          "id": "staging"
        }
      },
      "createdAt": "2015-05-18T11:29:46.809Z",
      "createdBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "7BslKh9TdKGOK41VmLDjFZ"
        }
      },
      "updatedAt": "2015-05-18T11:29:46.809Z",
      "updatedBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "4FLrUHftHW3v2BLi9fzfjU"
        }
      }
    },
    "displayField": "title",
    "name": "Blog Post",
    "description": "A blog post",
    "fields": [
      {
        "id": "title",
        "name": "Title",
        "type": "Text",
        "localized": true,
        "required": true,
        "validations": [],
        "disabled": false,
        "omitted": false
      },
      {
        "id": "body",
        "name": "Body",
        "type": "Text",
        "localized": true,
        "required": true,
        "validations": [],
        "disabled": false,
        "omitted": false
      }
    ]
  }
}

Create Entry​

Creates a new entry in a space. | key: createEntry

InputNotesExample
Connection

The Contentful connection to use.

Content Type ID

The unique identifier for the content type.

2PqfXUJwE8qSYKuM0U6w8M
Entry Data

The entry data as a JSON object containing fields and their values.

Environment ID

The unique identifier for the Contentful environment.

staging
Space ID

The unique identifier for the Contentful space.

yadj1kx9rmg0

{
  "data": {
    "fields": {
      "title": {
        "en-US": "Hello, World!"
      },
      "body": {
        "en-US": "Bacon is healthy!"
      }
    },
    "metadata": {
      "tags": [
        {
          "sys": {
            "type": "Link",
            "linkType": "Tag",
            "id": "nyCampaign"
          }
        }
      ]
    },
    "sys": {
      "id": "5KsDBWseXY6QegucYAoacS",
      "type": "Entry",
      "contentType": {
        "sys": {
          "type": "Link",
          "linkType": "ContentType",
          "id": "hfM9RCJIk0wIm06WkEOQY"
        }
      },
      "version": 1,
      "space": {
        "sys": {
          "type": "Link",
          "linkType": "Space",
          "id": "yadj1kx9rmg0"
        }
      },
      "environment": {
        "sys": {
          "type": "Link",
          "linkType": "Environment",
          "id": "staging"
        }
      },
      "createdAt": "2015-05-18T11:29:46.809Z",
      "createdBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "7BslKh9TdKGOK41VmLDjFZ"
        }
      },
      "updatedAt": "2015-05-18T11:29:46.809Z",
      "updatedBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "4FLrUHftHW3v2BLi9fzfjU"
        }
      }
    }
  }
}

Create Environment​

Creates a new environment. | key: createEnvironment

InputNotesExample
Connection

The Contentful connection to use.

Environment ID

The unique identifier for the Contentful environment.

staging
Environment Name

The display name for the environment.

Staging
Space ID

The unique identifier for the Contentful space.

yadj1kx9rmg0

{
  "data": {
    "name": "master",
    "sys": {
      "type": "Environment",
      "id": "master",
      "version": 1,
      "space": {
        "sys": {
          "type": "Link",
          "linkType": "Space",
          "id": "fm17kie1n0p4"
        }
      },
      "status": {
        "sys": {
          "type": "Link",
          "linkType": "Status",
          "id": "ready"
        }
      },
      "createdBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "5QvxuP1Kp8mVrw3PVcOp4t"
        }
      },
      "createdAt": "2024-01-29T18:33:02Z",
      "updatedBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "5QvxuP1Kp8mVrw3PVcOp4t"
        }
      },
      "updatedAt": "2024-01-29T18:33:02Z"
    }
  }
}

Create Space​

Creates a new space. | key: createSpace

InputNotesExample
Connection

The Contentful connection to use.

Default Locale

The default locale code for the space.

en
Space Name

The display name for the space.

My Space
Organization ID

The unique identifier for the organization.

1Qz7ThNuABCytfP4oqkF12

{
  "data": {
    "sys": {
      "type": "Space",
      "id": "yadj1kx9rmg0",
      "version": 3,
      "organization": {
        "sys": {
          "id": "0D9ZC8rLWiw6x5qizZGiRs",
          "type": "Link",
          "linkType": "Organization"
        }
      },
      "createdAt": "2015-05-18T11:29:46.809Z",
      "createdBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "7BslKh9TdKGOK41VmLDjFZ"
        }
      },
      "updatedAt": "2015-05-18T11:29:46.809Z",
      "updatedBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "4FLrUHftHW3v2BLi9fzfjU"
        }
      }
    },
    "name": "Contentful Example API"
  }
}

Create Webhook​

Creates a new webhook. | key: createWebhook

InputNotesExample
Connection

The Contentful connection to use.

Name

A descriptive label to identify the webhook in the Contentful dashboard.

Example Webhook
Space ID

The unique identifier for the Contentful space.

yadj1kx9rmg0
Events

The event types to subscribe to for this webhook.

Entry.create
URL

The URL where webhook events will be sent.

https://example.com/webhook

{
  "data": {
    "sys": {
      "type": "WebhookDefinition",
      "id": "0KzM2HxYr5O1pZ4SaUzK8h",
      "version": 1,
      "space": {
        "sys": {
          "type": "Link",
          "linkType": "Space",
          "id": "yadj1kx9rmg0"
        }
      },
      "createdAt": "2015-05-18T11:29:46.809Z",
      "createdBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "7BslKh9TdKGOK41VmLDjFZ"
        }
      },
      "updatedAt": "2015-05-18T11:29:46.809Z",
      "updatedBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "4FLrUHftHW3v2BLi9fzfjU"
        }
      }
    },
    "name": "My webhook",
    "url": "https://www.example.com",
    "topics": [
      "Entry.create",
      "ContentType.create",
      "*.publish",
      "Asset.*"
    ],
    "httpBasicUsername": "yolo",
    "headers": [
      {
        "key": "header1",
        "value": "value1"
      },
      {
        "key": "header2",
        "value": "value2"
      }
    ],
    "filters": [],
    "active": true
  }
}

Delete Asset​

Deletes an existing asset. | key: deleteAsset

InputNotesExample
Asset ID

The unique identifier for the asset.

wtrHxeu3zEoEce2MokCSi
Connection

The Contentful connection to use.

Environment ID

The unique identifier for the Contentful environment.

staging
Space ID

The unique identifier for the Contentful space.

yadj1kx9rmg0

{
  "data": {}
}

Delete Entry​

Deletes an existing entry. | key: deleteEntry

InputNotesExample
Connection

The Contentful connection to use.

Entry ID

The unique identifier for the entry.

5KsDBWseXY6QegucYAoacS
Environment ID

The unique identifier for the Contentful environment.

staging
Space ID

The unique identifier for the Contentful space.

yadj1kx9rmg0

{
  "data": {}
}

Delete Environment​

Deletes an existing environment. | key: deleteEnvironment

InputNotesExample
Connection

The Contentful connection to use.

Environment ID

The unique identifier for the Contentful environment.

staging
Space ID

The unique identifier for the Contentful space.

yadj1kx9rmg0

{
  "data": {}
}

Delete Instanced Webhooks​

Deletes all webhooks that point to a flow in the current instance. | key: deleteInstancedWebhooks

InputNotesExample
Connection

The Contentful connection to use.

Space ID

The unique identifier for the Contentful space.

yadj1kx9rmg0

Delete Space​

Deletes an existing space. | key: deleteSpace

InputNotesExample
Connection

The Contentful connection to use.

Space ID

The unique identifier for the Contentful space.

yadj1kx9rmg0

{
  "data": {}
}

Delete Upload​

Deletes a file from temporary data storage. | key: deleteUpload

InputNotesExample
Connection

The Contentful connection to use.

Environment ID

The unique identifier for the Contentful environment.

staging
Space ID

The unique identifier for the Contentful space.

yadj1kx9rmg0
Upload ID

The unique identifier for the upload.

2DNvIbYNELgqLJUkgTeIOV

{
  "data": {}
}

Delete Webhook​

Deletes an existing webhook. | key: deleteWebhook

InputNotesExample
Connection

The Contentful connection to use.

Space ID

The unique identifier for the Contentful space.

yadj1kx9rmg0
Webhook ID

The unique identifier for the webhook.

5KsDBWseXY6QegucYAoacS

{
  "data": {}
}

Get Asset​

Retrieves a single asset by ID. | key: getAsset

InputNotesExample
Asset ID

The unique identifier for the asset.

wtrHxeu3zEoEce2MokCSi
Connection

The Contentful connection to use.

Environment ID

The unique identifier for the Contentful environment.

staging
Space ID

The unique identifier for the Contentful space.

yadj1kx9rmg0

{
  "data": {
    "fields": {
      "title": {
        "en-US": "Playsam Streamliner"
      },
      "file": {
        "en-US": {
          "contentType": "image/jpeg",
          "fileName": "example.jpeg",
          "upload": "https://example.com/example.jpg"
        }
      }
    },
    "metadata": {
      "tags": [
        {
          "sys": {
            "type": "Link",
            "linkType": "Tag",
            "id": "nyCampaign"
          }
        }
      ]
    },
    "sys": {
      "id": "wtrHxeu3zEoEce2MokCSi",
      "type": "Asset",
      "version": 1,
      "space": {
        "sys": {
          "type": "Link",
          "linkType": "Space",
          "id": "yadj1kx9rmg0"
        }
      },
      "environment": {
        "sys": {
          "type": "Link",
          "linkType": "Environment",
          "id": "staging"
        }
      },
      "createdAt": "2015-05-18T11:29:46.809Z",
      "createdBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "7BslKh9TdKGOK41VmLDjFZ"
        }
      },
      "updatedAt": "2015-05-18T11:29:46.809Z",
      "updatedBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "4FLrUHftHW3v2BLi9fzfjU"
        }
      }
    }
  }
}

Get Bulk Action​

Retrieves a bulk action by ID. | key: getBulkAction

InputNotesExample
Bulk Action ID

The unique identifier for the bulk action.

5KsDBWseXY6QegucYAoacS
Connection

The Contentful connection to use.

Environment ID

The unique identifier for the Contentful environment.

staging
Space ID

The unique identifier for the Contentful space.

yadj1kx9rmg0

{
  "data": {
    "sys": {
      "id": "2OBWQpv6VaT1rZZXJ4nT3h",
      "type": "BulkAction",
      "status": "succeeded",
      "createdBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "7BslKh9TdKGOK41VmLDjFZ"
        }
      },
      "createdAt": "2020-01-01T13:00:00.000Z",
      "updatedAt": "2020-01-01T13:00:00.000Z",
      "space": {
        "sys": {
          "type": "Link",
          "linkType": "Space",
          "id": "yadj1kx9rmg0"
        }
      },
      "environment": {
        "sys": {
          "type": "Link",
          "linkType": "Environment",
          "id": "staging"
        }
      }
    },
    "action": "publish",
    "payload": {
      "entities": {
        "items": [
          {
            "sys": {
              "id": "5KsDBWseXY6QegucYAoacS",
              "type": "Link",
              "linkType": "Entry",
              "version": 1
            }
          }
        ]
      }
    },
    "error": null
  }
}

Get Entry​

Retrieves a single entry by ID. | key: getEntry

InputNotesExample
Connection

The Contentful connection to use.

Entry ID

The unique identifier for the entry.

5KsDBWseXY6QegucYAoacS
Environment ID

The unique identifier for the Contentful environment.

staging
Space ID

The unique identifier for the Contentful space.

yadj1kx9rmg0

{
  "data": {
    "fields": {
      "title": {
        "en-US": "Hello, World!"
      },
      "body": {
        "en-US": "Bacon is healthy!"
      }
    },
    "metadata": {
      "tags": [
        {
          "sys": {
            "type": "Link",
            "linkType": "Tag",
            "id": "nyCampaign"
          }
        }
      ]
    },
    "sys": {
      "id": "5KsDBWseXY6QegucYAoacS",
      "type": "Entry",
      "contentType": {
        "sys": {
          "type": "Link",
          "linkType": "ContentType",
          "id": "hfM9RCJIk0wIm06WkEOQY"
        }
      },
      "version": 1,
      "space": {
        "sys": {
          "type": "Link",
          "linkType": "Space",
          "id": "yadj1kx9rmg0"
        }
      },
      "environment": {
        "sys": {
          "type": "Link",
          "linkType": "Environment",
          "id": "staging"
        }
      },
      "createdAt": "2015-05-18T11:29:46.809Z",
      "createdBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "7BslKh9TdKGOK41VmLDjFZ"
        }
      },
      "updatedAt": "2015-05-18T11:29:46.809Z",
      "updatedBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "4FLrUHftHW3v2BLi9fzfjU"
        }
      }
    }
  }
}

Get Environment​

Retrieves a single environment by ID. | key: getEnvironment

InputNotesExample
Connection

The Contentful connection to use.

Environment ID

The unique identifier for the Contentful environment.

staging
Space ID

The unique identifier for the Contentful space.

yadj1kx9rmg0

{
  "data": {
    "name": "master",
    "sys": {
      "type": "Environment",
      "id": "master",
      "version": 1,
      "space": {
        "sys": {
          "type": "Link",
          "linkType": "Space",
          "id": "fm17kie1n0p4"
        }
      },
      "status": {
        "sys": {
          "type": "Link",
          "linkType": "Status",
          "id": "ready"
        }
      },
      "createdBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "5QvxuP1Kp8mVrw3PVcOp4t"
        }
      },
      "createdAt": "2024-01-29T18:33:02Z",
      "updatedBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "5QvxuP1Kp8mVrw3PVcOp4t"
        }
      },
      "updatedAt": "2024-01-29T18:33:02Z"
    }
  }
}

Get Organization​

Retrieves an organization by ID. | key: getOrganization

InputNotesExample
Connection

The Contentful connection to use.

Organization ID

The unique identifier for the organization.

1Qz7ThNuABCytfP4oqkF12

{
  "data": {
    "sys": {
      "type": "Organization",
      "id": "0D9ZC8rLWiw6x5qizZGiRs",
      "version": 1,
      "createdAt": "2015-05-18T11:29:46.809Z",
      "updatedAt": "2015-05-18T11:29:46.809Z"
    },
    "name": "My organization"
  }
}

Get Space​

Retrieves a single space by ID. | key: getSpace

InputNotesExample
Connection

The Contentful connection to use.

Space ID

The unique identifier for the Contentful space.

yadj1kx9rmg0

{
  "data": {
    "sys": {
      "type": "Space",
      "id": "yadj1kx9rmg0",
      "version": 3,
      "organization": {
        "sys": {
          "id": "0D9ZC8rLWiw6x5qizZGiRs",
          "type": "Link",
          "linkType": "Organization"
        }
      },
      "createdAt": "2015-05-18T11:29:46.809Z",
      "createdBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "7BslKh9TdKGOK41VmLDjFZ"
        }
      },
      "updatedAt": "2015-05-18T11:29:46.809Z",
      "updatedBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "4FLrUHftHW3v2BLi9fzfjU"
        }
      }
    },
    "name": "Contentful Example API"
  }
}

Get Upload​

Retrieves an unmodified image. | key: getUpload

InputNotesExample
Connection

The Contentful connection to use.

Environment ID

The unique identifier for the Contentful environment.

staging
Space ID

The unique identifier for the Contentful space.

yadj1kx9rmg0
Upload ID

The unique identifier for the upload.

2DNvIbYNELgqLJUkgTeIOV

{
  "data": {
    "sys": {
      "type": "Upload",
      "id": "2DNvIbYNELgqLJUkgTeIOV",
      "space": {
        "sys": {
          "type": "Link",
          "linkType": "Space",
          "id": "yadj1kx9rmg0"
        }
      },
      "expiresAt": "2015-05-18T11:29:46.809Z",
      "createdAt": "2015-05-18T11:29:46.809Z",
      "createdBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "4FLrUHftHW3v2BLi9fzfjU"
        }
      }
    }
  }
}

Get Webhook​

Retrieves a single webhook by ID. | key: getWebhook

InputNotesExample
Connection

The Contentful connection to use.

Space ID

The unique identifier for the Contentful space.

yadj1kx9rmg0
Webhook ID

The unique identifier for the webhook.

5KsDBWseXY6QegucYAoacS

{
  "data": {
    "sys": {
      "type": "WebhookDefinition",
      "id": "0KzM2HxYr5O1pZ4SaUzK8h",
      "version": 1,
      "space": {
        "sys": {
          "type": "Link",
          "linkType": "Space",
          "id": "yadj1kx9rmg0"
        }
      },
      "createdAt": "2015-05-18T11:29:46.809Z",
      "createdBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "7BslKh9TdKGOK41VmLDjFZ"
        }
      },
      "updatedAt": "2015-05-18T11:29:46.809Z",
      "updatedBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "4FLrUHftHW3v2BLi9fzfjU"
        }
      }
    },
    "name": "My webhook",
    "url": "https://www.example.com",
    "topics": [
      "Entry.create",
      "ContentType.create",
      "*.publish",
      "Asset.*"
    ],
    "httpBasicUsername": "yolo",
    "headers": [
      {
        "key": "header1",
        "value": "value1"
      },
      {
        "key": "header2",
        "value": "value2"
      }
    ],
    "filters": [],
    "active": true
  }
}

List Assets​

Retrieves all assets of a space. | key: listAssets

InputNotesExample
Connection

The Contentful connection to use.

Environment ID

The unique identifier for the Contentful environment.

staging
Space ID

The unique identifier for the Contentful space.

yadj1kx9rmg0

{
  "data": [
    {
      "fields": {
        "title": {
          "en-US": "Playsam Streamliner"
        },
        "file": {
          "en-US": {
            "contentType": "image/jpeg",
            "fileName": "example.jpeg",
            "upload": "https://example.com/example.jpg"
          }
        }
      },
      "metadata": {
        "tags": [
          {
            "sys": {
              "type": "Link",
              "linkType": "Tag",
              "id": "nyCampaign"
            }
          }
        ]
      },
      "sys": {
        "id": "wtrHxeu3zEoEce2MokCSi",
        "type": "Asset",
        "version": 1,
        "space": {
          "sys": {
            "type": "Link",
            "linkType": "Space",
            "id": "yadj1kx9rmg0"
          }
        },
        "environment": {
          "sys": {
            "type": "Link",
            "linkType": "Environment",
            "id": "staging"
          }
        },
        "createdAt": "2015-05-18T11:29:46.809Z",
        "createdBy": {
          "sys": {
            "type": "Link",
            "linkType": "User",
            "id": "7BslKh9TdKGOK41VmLDjFZ"
          }
        },
        "updatedAt": "2015-05-18T11:29:46.809Z",
        "updatedBy": {
          "sys": {
            "type": "Link",
            "linkType": "User",
            "id": "4FLrUHftHW3v2BLi9fzfjU"
          }
        }
      }
    }
  ]
}

List Content Types​

Retrieves all content types of a space. | key: listContentTypes

InputNotesExample
Connection

The Contentful connection to use.

Environment ID

The unique identifier for the Contentful environment.

staging
Space ID

The unique identifier for the Contentful space.

yadj1kx9rmg0

{
  "data": [
    {
      "sys": {
        "type": "ContentType",
        "id": "3ORKIAOaJqQWWg86MWkyOs",
        "version": 1,
        "space": {
          "sys": {
            "type": "Link",
            "linkType": "Space",
            "id": "yadj1kx9rmg0"
          }
        },
        "environment": {
          "sys": {
            "type": "Link",
            "linkType": "Environment",
            "id": "staging"
          }
        },
        "createdAt": "2015-05-18T11:29:46.809Z",
        "createdBy": {
          "sys": {
            "type": "Link",
            "linkType": "User",
            "id": "7BslKh9TdKGOK41VmLDjFZ"
          }
        },
        "updatedAt": "2015-05-18T11:29:46.809Z",
        "updatedBy": {
          "sys": {
            "type": "Link",
            "linkType": "User",
            "id": "4FLrUHftHW3v2BLi9fzfjU"
          }
        }
      },
      "displayField": "title",
      "name": "Blog Post",
      "description": "A blog post",
      "fields": [
        {
          "id": "title",
          "name": "Title",
          "type": "Text",
          "localized": true,
          "required": true,
          "validations": [],
          "disabled": false,
          "omitted": false
        },
        {
          "id": "body",
          "name": "Body",
          "type": "Text",
          "localized": true,
          "required": true,
          "validations": [],
          "disabled": false,
          "omitted": false
        }
      ]
    }
  ]
}

List Entries​

Retrieves all entries of a space. | key: listEntries

InputNotesExample
Connection

The Contentful connection to use.

Environment ID

The unique identifier for the Contentful environment.

staging
Space ID

The unique identifier for the Contentful space.

yadj1kx9rmg0

{
  "data": [
    {
      "fields": {
        "title": {
          "en-US": "Hello, World!"
        },
        "body": {
          "en-US": "Bacon is healthy!"
        }
      },
      "metadata": {
        "tags": [
          {
            "sys": {
              "type": "Link",
              "linkType": "Tag",
              "id": "nyCampaign"
            }
          }
        ]
      },
      "sys": {
        "id": "5KsDBWseXY6QegucYAoacS",
        "type": "Entry",
        "contentType": {
          "sys": {
            "type": "Link",
            "linkType": "ContentType",
            "id": "hfM9RCJIk0wIm06WkEOQY"
          }
        },
        "version": 1,
        "space": {
          "sys": {
            "type": "Link",
            "linkType": "Space",
            "id": "yadj1kx9rmg0"
          }
        },
        "environment": {
          "sys": {
            "type": "Link",
            "linkType": "Environment",
            "id": "staging"
          }
        },
        "createdAt": "2015-05-18T11:29:46.809Z",
        "createdBy": {
          "sys": {
            "type": "Link",
            "linkType": "User",
            "id": "7BslKh9TdKGOK41VmLDjFZ"
          }
        },
        "updatedAt": "2015-05-18T11:29:46.809Z",
        "updatedBy": {
          "sys": {
            "type": "Link",
            "linkType": "User",
            "id": "4FLrUHftHW3v2BLi9fzfjU"
          }
        }
      }
    }
  ]
}

List Environments​

Retrieves all environments in a space. | key: listEnvironments

InputNotesExample
Connection

The Contentful connection to use.

Space ID

The unique identifier for the Contentful space.

yadj1kx9rmg0

{
  "data": [
    {
      "name": "master",
      "sys": {
        "type": "Environment",
        "id": "master",
        "version": 1,
        "space": {
          "sys": {
            "type": "Link",
            "linkType": "Space",
            "id": "fm17kie1n0p4"
          }
        },
        "status": {
          "sys": {
            "type": "Link",
            "linkType": "Status",
            "id": "ready"
          }
        },
        "createdBy": {
          "sys": {
            "type": "Link",
            "linkType": "User",
            "id": "5QvxuP1Kp8mVrw3PVcOp4t"
          }
        },
        "createdAt": "2024-01-29T18:33:02Z",
        "updatedBy": {
          "sys": {
            "type": "Link",
            "linkType": "User",
            "id": "5QvxuP1Kp8mVrw3PVcOp4t"
          }
        },
        "updatedAt": "2024-01-29T18:33:02Z"
      }
    }
  ]
}

List Organizations​

Retrieves all organizations the account has access to. | key: listOrganizations

InputNotesExample
Connection

The Contentful connection to use.

{
  "data": [
    {
      "sys": {
        "type": "Organization",
        "id": "0D9ZC8rLWiw6x5qizZGiRs",
        "version": 1,
        "createdAt": "2015-05-18T11:29:46.809Z",
        "updatedAt": "2015-05-18T11:29:46.809Z"
      },
      "name": "My organization"
    }
  ]
}

List Published Entries​

Retrieves all published entries of a space. | key: listPublishedEntries

InputNotesExample
Connection

The Contentful connection to use.

Environment ID

The unique identifier for the Contentful environment.

staging
Space ID

The unique identifier for the Contentful space.

yadj1kx9rmg0

{
  "data": [
    {
      "fields": {
        "title": {
          "en-US": "Hello, World!"
        },
        "body": {
          "en-US": "Bacon is healthy!"
        }
      },
      "metadata": {
        "tags": [
          {
            "sys": {
              "type": "Link",
              "linkType": "Tag",
              "id": "nyCampaign"
            }
          }
        ]
      },
      "sys": {
        "id": "5KsDBWseXY6QegucYAoacS",
        "type": "Entry",
        "contentType": {
          "sys": {
            "type": "Link",
            "linkType": "ContentType",
            "id": "hfM9RCJIk0wIm06WkEOQY"
          }
        },
        "version": 1,
        "space": {
          "sys": {
            "type": "Link",
            "linkType": "Space",
            "id": "yadj1kx9rmg0"
          }
        },
        "environment": {
          "sys": {
            "type": "Link",
            "linkType": "Environment",
            "id": "staging"
          }
        },
        "createdAt": "2015-05-18T11:29:46.809Z",
        "createdBy": {
          "sys": {
            "type": "Link",
            "linkType": "User",
            "id": "7BslKh9TdKGOK41VmLDjFZ"
          }
        },
        "updatedAt": "2015-05-18T11:29:46.809Z",
        "updatedBy": {
          "sys": {
            "type": "Link",
            "linkType": "User",
            "id": "4FLrUHftHW3v2BLi9fzfjU"
          }
        }
      }
    }
  ]
}

List Spaces​

Retrieves all spaces the account has access to. | key: listSpaces

InputNotesExample
Connection

The Contentful connection to use.

{
  "data": [
    {
      "sys": {
        "type": "Space",
        "id": "yadj1kx9rmg0",
        "version": 3,
        "organization": {
          "sys": {
            "id": "0D9ZC8rLWiw6x5qizZGiRs",
            "type": "Link",
            "linkType": "Organization"
          }
        },
        "createdAt": "2015-05-18T11:29:46.809Z",
        "createdBy": {
          "sys": {
            "type": "Link",
            "linkType": "User",
            "id": "7BslKh9TdKGOK41VmLDjFZ"
          }
        },
        "updatedAt": "2015-05-18T11:29:46.809Z",
        "updatedBy": {
          "sys": {
            "type": "Link",
            "linkType": "User",
            "id": "4FLrUHftHW3v2BLi9fzfjU"
          }
        }
      },
      "name": "Contentful Example API"
    }
  ]
}

List Webhooks​

Retrieves all webhooks of a space. | key: listWebhooks

InputNotesExample
Connection

The Contentful connection to use.

Space ID

The unique identifier for the Contentful space.

yadj1kx9rmg0

{
  "data": [
    {
      "sys": {
        "type": "WebhookDefinition",
        "id": "0KzM2HxYr5O1pZ4SaUzK8h",
        "version": 1,
        "space": {
          "sys": {
            "type": "Link",
            "linkType": "Space",
            "id": "yadj1kx9rmg0"
          }
        },
        "createdAt": "2015-05-18T11:29:46.809Z",
        "createdBy": {
          "sys": {
            "type": "Link",
            "linkType": "User",
            "id": "7BslKh9TdKGOK41VmLDjFZ"
          }
        },
        "updatedAt": "2015-05-18T11:29:46.809Z",
        "updatedBy": {
          "sys": {
            "type": "Link",
            "linkType": "User",
            "id": "4FLrUHftHW3v2BLi9fzfjU"
          }
        }
      },
      "name": "My webhook",
      "url": "https://www.example.com",
      "topics": [
        "Entry.create",
        "ContentType.create",
        "*.publish",
        "Asset.*"
      ],
      "httpBasicUsername": "yolo",
      "headers": [
        {
          "key": "header1",
          "value": "value1"
        },
        {
          "key": "header2",
          "value": "value2"
        }
      ],
      "filters": [],
      "active": true
    }
  ]
}

Patch Entry​

Applies partial updates to an entry using JSON Patch (RFC 6902) operations. | key: patchEntry

InputNotesExample
Connection

The Contentful connection to use.

Entry ID

The unique identifier for the entry.

5KsDBWseXY6QegucYAoacS
Entry Version

The current version number of the entry. Required for optimistic locking.

1
Environment ID

The unique identifier for the Contentful environment.

staging
Patch Operations

A JSON array of JSON Patch (RFC 6902) operations.

Space ID

The unique identifier for the Contentful space.

yadj1kx9rmg0

{
  "data": {
    "data": {
      "fields": {
        "title": {
          "en-US": "Hello, World!"
        },
        "body": {
          "en-US": "Bacon is healthy!"
        }
      },
      "metadata": {
        "tags": [
          {
            "sys": {
              "type": "Link",
              "linkType": "Tag",
              "id": "nyCampaign"
            }
          }
        ]
      },
      "sys": {
        "id": "5KsDBWseXY6QegucYAoacS",
        "type": "Entry",
        "contentType": {
          "sys": {
            "type": "Link",
            "linkType": "ContentType",
            "id": "hfM9RCJIk0wIm06WkEOQY"
          }
        },
        "version": 1,
        "space": {
          "sys": {
            "type": "Link",
            "linkType": "Space",
            "id": "yadj1kx9rmg0"
          }
        },
        "environment": {
          "sys": {
            "type": "Link",
            "linkType": "Environment",
            "id": "staging"
          }
        },
        "createdAt": "2015-05-18T11:29:46.809Z",
        "createdBy": {
          "sys": {
            "type": "Link",
            "linkType": "User",
            "id": "7BslKh9TdKGOK41VmLDjFZ"
          }
        },
        "updatedAt": "2015-05-18T11:29:46.809Z",
        "updatedBy": {
          "sys": {
            "type": "Link",
            "linkType": "User",
            "id": "4FLrUHftHW3v2BLi9fzfjU"
          }
        }
      }
    }
  }
}

Process Asset​

Processes an asset for content delivery. | key: processAsset

InputNotesExample
Asset ID

The unique identifier for the asset.

wtrHxeu3zEoEce2MokCSi
Connection

The Contentful connection to use.

Environment ID

The unique identifier for the Contentful environment.

staging
Space ID

The unique identifier for the Contentful space.

yadj1kx9rmg0

{
  "data": {}
}

Publish Asset​

Publishes an asset. | key: publishAnAsset

InputNotesExample
Asset ID

The unique identifier for the asset.

wtrHxeu3zEoEce2MokCSi
Connection

The Contentful connection to use.

Environment ID

The unique identifier for the Contentful environment.

staging
Space ID

The unique identifier for the Contentful space.

yadj1kx9rmg0

{
  "data": {
    "fields": {
      "title": {
        "en-US": "Playsam Streamliner"
      },
      "file": {
        "en-US": {
          "contentType": "image/jpeg",
          "fileName": "example.jpeg",
          "upload": "https://example.com/example.jpg"
        }
      }
    },
    "metadata": {
      "tags": [
        {
          "sys": {
            "type": "Link",
            "linkType": "Tag",
            "id": "nyCampaign"
          }
        }
      ]
    },
    "sys": {
      "firstPublishedAt": "2015-05-15T13:38:11.311Z",
      "publishedCounter": 2,
      "publishedAt": "2015-05-15T13:38:11.311Z",
      "publishedBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "4FLrUHftHW3v2BLi9fzfjU"
        }
      },
      "publishedVersion": 9
    }
  }
}

Publish Bulk Action​

Publishes a bulk action. | key: publishBulkAction

InputNotesExample
Connection

The Contentful connection to use.

Environment ID

The unique identifier for the Contentful environment.

staging
Items

The items to be processed in the bulk action as a JSON object containing entities and actions.

Space ID

The unique identifier for the Contentful space.

yadj1kx9rmg0

{
  "data": {
    "sys": {
      "id": "2OBWQpv6VaT1rZZXJ4nT3h",
      "type": "BulkAction",
      "status": "succeeded",
      "createdBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "7BslKh9TdKGOK41VmLDjFZ"
        }
      },
      "createdAt": "2020-01-01T13:00:00.000Z",
      "updatedAt": "2020-01-01T13:00:00.000Z",
      "space": {
        "sys": {
          "type": "Link",
          "id": "yadj1kx9rmg0"
        }
      },
      "environment": {
        "sys": {
          "type": "Link",
          "id": "staging"
        }
      }
    },
    "action": "publish",
    "payload": {
      "entities": {
        "items": [
          {
            "sys": {
              "id": "5KsDBWseXY6QegucYAoacS",
              "type": "Link",
              "linkType": "Entry",
              "version": 1
            }
          }
        ]
      }
    },
    "error": null
  }
}

Publish Entry​

Publishes an entry. | key: publishEntry

InputNotesExample
Connection

The Contentful connection to use.

Entry ID

The unique identifier for the entry.

5KsDBWseXY6QegucYAoacS
Environment ID

The unique identifier for the Contentful environment.

staging
Space ID

The unique identifier for the Contentful space.

yadj1kx9rmg0

{
  "data": {
    "fields": {
      "title": {
        "en-US": "Hello, World!"
      },
      "body": {
        "en-US": "Bacon is healthy!"
      }
    },
    "metadata": {
      "tags": [
        {
          "sys": {
            "type": "Link",
            "linkType": "Tag",
            "id": "nyCampaign"
          }
        }
      ]
    },
    "sys": {
      "firstPublishedAt": "2015-05-15T13:38:11.311Z",
      "publishedCounter": 2,
      "publishedAt": "2015-05-15T13:38:11.311Z",
      "publishedBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "4FLrUHftHW3v2BLi9fzfjU"
        }
      },
      "publishedVersion": 9
    }
  }
}

Put Entry​

Replaces all fields of an existing entry with the provided data. | key: putEntry

InputNotesExample
Connection

The Contentful connection to use.

Entry Data

The full entry data as a JSON object. All existing fields will be replaced with the provided data.

Entry ID

The unique identifier for the entry.

5KsDBWseXY6QegucYAoacS
Environment ID

The unique identifier for the Contentful environment.

staging
Space ID

The unique identifier for the Contentful space.

yadj1kx9rmg0

{
  "data": {
    "data": {
      "fields": {
        "title": {
          "en-US": "Hello, World!"
        },
        "body": {
          "en-US": "Bacon is healthy!"
        }
      },
      "metadata": {
        "tags": [
          {
            "sys": {
              "type": "Link",
              "linkType": "Tag",
              "id": "nyCampaign"
            }
          }
        ]
      },
      "sys": {
        "id": "5KsDBWseXY6QegucYAoacS",
        "type": "Entry",
        "contentType": {
          "sys": {
            "type": "Link",
            "linkType": "ContentType",
            "id": "hfM9RCJIk0wIm06WkEOQY"
          }
        },
        "version": 1,
        "space": {
          "sys": {
            "type": "Link",
            "linkType": "Space",
            "id": "yadj1kx9rmg0"
          }
        },
        "environment": {
          "sys": {
            "type": "Link",
            "linkType": "Environment",
            "id": "staging"
          }
        },
        "createdAt": "2015-05-18T11:29:46.809Z",
        "createdBy": {
          "sys": {
            "type": "Link",
            "linkType": "User",
            "id": "7BslKh9TdKGOK41VmLDjFZ"
          }
        },
        "updatedAt": "2015-05-18T11:29:46.809Z",
        "updatedBy": {
          "sys": {
            "type": "Link",
            "linkType": "User",
            "id": "4FLrUHftHW3v2BLi9fzfjU"
          }
        }
      }
    }
  }
}

Raw Request​

Sends a raw HTTP request to the Contentful API. | key: rawRequest

InputNotesExample
Connection

The Contentful connection to use.

Data

The HTTP body payload to send to the URL.

{"exampleKey": "Example Data"}
File Data

File Data to be sent as a multipart form upload.

[{key: "example.txt", value: "My File Contents"}]
File Data File Names

File names to apply to the file data inputs. Keys must match the file data keys above.

Form Data

The Form Data to be sent as a multipart form upload.

[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header

A list of headers to send with the request.

User-Agent: curl/7.64.1
Max Retry Count

The maximum number of retries to attempt. Specify 0 for no retries.

0
Method

The HTTP method to use.

Query Parameter

A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.

Response Type

The type of data you expect in the response. You can request json, text, or binary data.

json
Retry On All Errors

If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.

false
Retry Delay (ms)

The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.

0
Timeout

The maximum time that a client will await a response to its request

2000
URL

Input the path only (/spaces), The base URL is already included (https://api.contentful.com). For example, to connect to https://api.contentful.com/spaces, only /spaces is entered in this field.

/spaces
Use Exponential Backoff

Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.

false

Unarchive Entry​

Unarchives an existing entry. | key: unarchiveEntry

InputNotesExample
Connection

The Contentful connection to use.

Entry ID

The unique identifier for the entry.

5KsDBWseXY6QegucYAoacS
Environment ID

The unique identifier for the Contentful environment.

staging
Space ID

The unique identifier for the Contentful space.

yadj1kx9rmg0

{
  "data": {
    "fields": {
      "title": {
        "en-US": "Hello, World!"
      },
      "body": {
        "en-US": "Bacon is healthy!"
      }
    },
    "metadata": {
      "tags": [
        {
          "sys": {
            "type": "Link",
            "linkType": "Tag",
            "id": "nyCampaign"
          }
        }
      ]
    },
    "sys": {
      "id": "5KsDBWseXY6QegucYAoacS",
      "type": "Entry",
      "contentType": {
        "sys": {
          "type": "Link",
          "linkType": "ContentType",
          "id": "hfM9RCJIk0wIm06WkEOQY"
        }
      },
      "version": 1,
      "space": {
        "sys": {
          "type": "Link",
          "linkType": "Space",
          "id": "yadj1kx9rmg0"
        }
      },
      "environment": {
        "sys": {
          "type": "Link",
          "linkType": "Environment",
          "id": "staging"
        }
      },
      "createdAt": "2015-05-18T11:29:46.809Z",
      "createdBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "7BslKh9TdKGOK41VmLDjFZ"
        }
      },
      "updatedAt": "2015-05-18T11:29:46.809Z",
      "updatedBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "4FLrUHftHW3v2BLi9fzfjU"
        }
      }
    }
  }
}

Unpublish Asset​

Unpublishes an asset. | key: unpublishAnAsset

InputNotesExample
Asset ID

The unique identifier for the asset.

wtrHxeu3zEoEce2MokCSi
Connection

The Contentful connection to use.

Environment ID

The unique identifier for the Contentful environment.

staging
Space ID

The unique identifier for the Contentful space.

yadj1kx9rmg0

{
  "data": {
    "fields": {
      "title": {
        "en-US": "Playsam Streamliner"
      },
      "file": {
        "en-US": {
          "contentType": "image/jpeg",
          "fileName": "example.jpeg",
          "upload": "https://example.com/example.jpg"
        }
      }
    },
    "metadata": {
      "tags": [
        {
          "sys": {
            "type": "Link",
            "linkType": "Tag",
            "id": "nyCampaign"
          }
        }
      ]
    },
    "sys": {
      "id": "wtrHxeu3zEoEce2MokCSi",
      "type": "Asset",
      "version": 1,
      "space": {
        "sys": {
          "type": "Link",
          "linkType": "Space",
          "id": "yadj1kx9rmg0"
        }
      },
      "environment": {
        "sys": {
          "type": "Link",
          "linkType": "Environment",
          "id": "staging"
        }
      },
      "createdAt": "2015-05-18T11:29:46.809Z",
      "createdBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "7BslKh9TdKGOK41VmLDjFZ"
        }
      },
      "updatedAt": "2015-05-18T11:29:46.809Z",
      "updatedBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "4FLrUHftHW3v2BLi9fzfjU"
        }
      }
    }
  }
}

Unpublish Bulk Action​

Unpublishes a bulk action. | key: unpublishBulkAction

InputNotesExample
Connection

The Contentful connection to use.

Environment ID

The unique identifier for the Contentful environment.

staging
Items

The items to be unpublished in the bulk action as a JSON object containing entities to unpublish.

Space ID

The unique identifier for the Contentful space.

yadj1kx9rmg0

{
  "data": {
    "sys": {
      "id": "2OBWQpv6VaT1rZZXJ4nT3h",
      "type": "BulkAction",
      "status": "succeeded",
      "createdBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "7BslKh9TdKGOK41VmLDjFZ"
        }
      },
      "createdAt": "2020-01-01T13:00:00.000Z",
      "updatedAt": "2020-01-01T13:00:00.000Z",
      "space": {
        "sys": {
          "type": "Link",
          "id": "yadj1kx9rmg0"
        }
      },
      "environment": {
        "sys": {
          "type": "Link",
          "id": "staging"
        }
      }
    },
    "action": "publish",
    "payload": {
      "entities": {
        "items": [
          {
            "sys": {
              "id": "5KsDBWseXY6QegucYAoacS",
              "type": "Link",
              "linkType": "Entry",
              "version": 1
            }
          }
        ]
      }
    },
    "error": null
  }
}

Unpublish Entry​

Unpublishes an entry. | key: unpublishEntry

InputNotesExample
Connection

The Contentful connection to use.

Entry ID

The unique identifier for the entry.

5KsDBWseXY6QegucYAoacS
Environment ID

The unique identifier for the Contentful environment.

staging
Space ID

The unique identifier for the Contentful space.

yadj1kx9rmg0

{
  "data": {
    "fields": {
      "title": {
        "en-US": "Hello, World!"
      },
      "body": {
        "en-US": "Bacon is healthy!"
      }
    },
    "metadata": {
      "tags": [
        {
          "sys": {
            "type": "Link",
            "linkType": "Tag",
            "id": "nyCampaign"
          }
        }
      ]
    }
  }
}

Update Asset​

Updates an existing asset. | key: updateAsset

InputNotesExample
Asset ID

The unique identifier for the asset.

wtrHxeu3zEoEce2MokCSi
Connection

The Contentful connection to use.

Asset Description

The updated description of the asset. Locale key must match the original locale of the asset to be updated.

Environment ID

The unique identifier for the Contentful environment.

staging
Space ID

The unique identifier for the Contentful space.

yadj1kx9rmg0
Title

The updated title of the asset. Locale key must match the original locale of the asset to be updated.

{
  "data": {
    "fields": {
      "title": {
        "en-US": "Playsam Streamliner"
      },
      "file": {
        "en-US": {
          "contentType": "image/jpeg",
          "fileName": "example.jpeg",
          "upload": "https://example.com/example.jpg"
        }
      }
    },
    "metadata": {
      "tags": [
        {
          "sys": {
            "type": "Link",
            "linkType": "Tag",
            "id": "nyCampaign"
          }
        }
      ]
    },
    "sys": {
      "id": "wtrHxeu3zEoEce2MokCSi",
      "type": "Asset",
      "version": 1,
      "space": {
        "sys": {
          "type": "Link",
          "linkType": "Space",
          "id": "yadj1kx9rmg0"
        }
      },
      "environment": {
        "sys": {
          "type": "Link",
          "linkType": "Environment",
          "id": "staging"
        }
      },
      "createdAt": "2015-05-18T11:29:46.809Z",
      "createdBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "7BslKh9TdKGOK41VmLDjFZ"
        }
      },
      "updatedAt": "2015-05-18T11:29:46.809Z",
      "updatedBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "4FLrUHftHW3v2BLi9fzfjU"
        }
      }
    }
  }
}

Update Content Type​

Updates an existing content type. | key: updateContentType

InputNotesExample
Connection

The Contentful connection to use.

Content Type ID

The unique identifier for the content type.

2PqfXUJwE8qSYKuM0U6w8M
Description

The updated description for the content type.

A blog post
Display Field

The updated field used as the main display field for entries.

title
Environment ID

The unique identifier for the Contentful environment.

staging
Content Type Fields

The updated field definitions for the content type.

Content Type Name

The updated name for the content type.

Blog Post
Space ID

The unique identifier for the Contentful space.

yadj1kx9rmg0

{
  "data": {
    "sys": {
      "type": "ContentType",
      "id": "3ORKIAOaJqQWWg86MWkyOs",
      "version": 1,
      "space": {
        "sys": {
          "type": "Link",
          "linkType": "Space",
          "id": "yadj1kx9rmg0"
        }
      },
      "environment": {
        "sys": {
          "type": "Link",
          "linkType": "Environment",
          "id": "staging"
        }
      },
      "createdAt": "2015-05-18T11:29:46.809Z",
      "createdBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "7BslKh9TdKGOK41VmLDjFZ"
        }
      },
      "updatedAt": "2015-05-18T11:29:46.809Z",
      "updatedBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "4FLrUHftHW3v2BLi9fzfjU"
        }
      }
    },
    "displayField": "title",
    "name": "Blog Post",
    "description": "A blog post",
    "fields": [
      {
        "id": "title",
        "name": "Title",
        "type": "Text",
        "localized": true,
        "required": true,
        "validations": [],
        "disabled": false,
        "omitted": false
      },
      {
        "id": "body",
        "name": "Body",
        "type": "Text",
        "localized": true,
        "required": true,
        "validations": [],
        "disabled": false,
        "omitted": false
      }
    ]
  }
}

Update Environment​

Updates an existing environment. | key: updateEnvironment

InputNotesExample
Connection

The Contentful connection to use.

Environment ID

The unique identifier for the Contentful environment.

staging
Environment Name

The updated name for the environment.

Staging
Space ID

The unique identifier for the Contentful space.

yadj1kx9rmg0

{
  "data": {
    "name": "master",
    "sys": {
      "type": "Environment",
      "id": "master",
      "version": 1,
      "space": {
        "sys": {
          "type": "Link",
          "linkType": "Space",
          "id": "fm17kie1n0p4"
        }
      },
      "status": {
        "sys": {
          "type": "Link",
          "linkType": "Status",
          "id": "ready"
        }
      },
      "createdBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "5QvxuP1Kp8mVrw3PVcOp4t"
        }
      },
      "createdAt": "2024-01-29T18:33:02Z",
      "updatedBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "5QvxuP1Kp8mVrw3PVcOp4t"
        }
      },
      "updatedAt": "2024-01-29T18:33:02Z"
    }
  }
}

Update Organization​

Updates the security contact for an organization. | key: updateOrganization

InputNotesExample
Connection

The Contentful connection to use.

Organization ID

The unique identifier for the organization.

1Qz7ThNuABCytfP4oqkF12
Security ID

The unique identifier for the security contact.

srdfsguf8325yusf24

{
  "data": {
    "email": "example@gmail.com",
    "sys": {
      "type": "Security Contact",
      "id": "srdfsguf8325yusf24",
      "version": "1",
      "organization": {
        "sys": {
          "id": "0D9ZC8rLWiw6x5qizZGiRs",
          "type": "Link",
          "linkType": "Organization"
        }
      },
      "createdBy": {
        "sys": {
          "id": "1xGZIRXr2WPnsLkKfREo0z",
          "type": "Link",
          "linkType": "User"
        }
      },
      "updatedBy": {
        "sys": {
          "id": "1xGZIRXr2WPnsLkKfREo0z",
          "type": "Link",
          "linkType": "User"
        }
      },
      "createdAt": "2019-05-18T11:39:46.809Z",
      "updatedAt": "2019-05-18T11:39:46.809Z"
    }
  }
}

Update Space​

Updates an existing space. | key: updateSpace

InputNotesExample
Connection

The Contentful connection to use.

Space ID

The unique identifier for the Contentful space.

yadj1kx9rmg0
Space Name

The updated name for the space.

My Space

{
  "data": {
    "sys": {
      "type": "Space",
      "id": "yadj1kx9rmg0",
      "version": 3,
      "organization": {
        "sys": {
          "id": "0D9ZC8rLWiw6x5qizZGiRs",
          "type": "Link",
          "linkType": "Organization"
        }
      },
      "createdAt": "2015-05-18T11:29:46.809Z",
      "createdBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "7BslKh9TdKGOK41VmLDjFZ"
        }
      },
      "updatedAt": "2015-05-18T11:29:46.809Z",
      "updatedBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "4FLrUHftHW3v2BLi9fzfjU"
        }
      }
    },
    "name": "Contentful Example API"
  }
}

Update Webhook​

Updates an existing webhook. | key: updateWebhook

InputNotesExample
Connection

The Contentful connection to use.

Name

The updated name for the webhook.

Example Webhook
Space ID

The unique identifier for the Contentful space.

yadj1kx9rmg0
Webhook ID

The unique identifier for the webhook.

5KsDBWseXY6QegucYAoacS

{
  "data": {
    "sys": {
      "type": "WebhookDefinition",
      "id": "0KzM2HxYr5O1pZ4SaUzK8h",
      "version": 1,
      "space": {
        "sys": {
          "type": "Link",
          "linkType": "Space",
          "id": "yadj1kx9rmg0"
        }
      },
      "createdAt": "2015-05-18T11:29:46.809Z",
      "createdBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "7BslKh9TdKGOK41VmLDjFZ"
        }
      },
      "updatedAt": "2015-05-18T11:29:46.809Z",
      "updatedBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "4FLrUHftHW3v2BLi9fzfjU"
        }
      }
    },
    "name": "My webhook",
    "url": "https://www.example.com",
    "topics": [
      "Entry.create",
      "ContentType.create",
      "*.publish",
      "Asset.*"
    ],
    "httpBasicUsername": "yolo",
    "headers": [
      {
        "key": "header1",
        "value": "value1"
      },
      {
        "key": "header2",
        "value": "value2"
      }
    ],
    "filters": [],
    "active": true
  }
}

Upload File​

Uploads a file to temporary file storage. | key: uploadFile

InputNotesExample
Connection

The Contentful connection to use.

File Contents

The contents to write to a file. This can be a string of text, it can be binary data that was generated in a previous step.

My File Contents
Space ID

The unique identifier for the Contentful space.

yadj1kx9rmg0

{
  "data": {
    "sys": {
      "type": "Upload",
      "id": "2DNvIbYNELgqLJUkgTeIOV",
      "space": {
        "sys": {
          "type": "Link",
          "linkType": "Space",
          "id": "yadj1kx9rmg0"
        }
      },
      "expiresAt": "2015-05-18T11:29:46.809Z",
      "createdAt": "2015-05-18T11:29:46.809Z",
      "createdBy": {
        "sys": {
          "type": "Link",
          "linkType": "User",
          "id": "4FLrUHftHW3v2BLi9fzfjU"
        }
      }
    }
  }
}

Changelog​

2026-04-06​

Added Archive Entry, Unarchive Entry, Put Entry, Patch Entry, and List Published Entries actions

2026-03-24​

Added Template ID input to the Select Environment Template inline data source for selecting environment templates from a dropdown

2026-03-05​

Added inline data sources for content types, entries, assets, and webhooks to enhance resource selection with dropdown pickers

Updated OAuth scope default to use a single scope per authorization request, resolving an authorization error on Contentful's consent page caused by the previous multi-scope default