Contentful
Contentful is a content management system (CMS) designed to help you create, manage, and distribute content across various platforms. Unlike traditional CMSs, Contentful is headless, focusing solely on managing content without being tied to a specific front-end presentation layer.
How to Integrate Contentful with ZBrain Flow
To integrate Contentful with ZBrain Flow:
Click the ‘+’ button in ZBrain Flow.
Type "Contentful" in the search bar and select it from the available options.
Choose an action to begin the setup process.
How to Create a Connection with Contentful in ZBrain Flow
To establish a connection between Contentful and ZBrain Flow:
Enter a Connection Name – Provide a name for easy identification.
Enter the Contentful Access Token, Space and Environment.
To get the required credentials, follow these steps:
Access Token:
Content Delivery API: Create API keys in the Contentful web app by navigating to Settings > API Keys in your space and generating a new token.
Content Management API: Use Personal Access Tokens (PATs) for simpler access. These can be created in the Contentful web app under Settings > API Keys.
Space:
A space is like a project container that stores entries, assets, and content types.
Each space has a unique ID and can be accessed via the Contentful APIs.
Environment:
Environments represent different content stages, such as development, staging, and production.
The default environment is usually named "master,” but additional environments can be created for testing.
Click ‘Save’ to finalize the setup.
Once connected, ZBrain Flow can interact with Contentful to retrieve, update, delete, and automate content management operations.
Key Terms in Contentful
Content Model
A content model defines the structure of content stored in Contentful. It consists of different fields (such as text, images, numbers, or references) that determine how content is organized. To find a content model:
Go to Contentful Web App → Content Model section.
Select the required model to view its structure and fields.
Locale
Locales define language variations for your content. If your project supports multiple languages, you can choose the specific locale while searching, retrieving, or creating content. To find available locales:
Navigate to Settings → Locales in the Contentful web app.
Entity ID
The entity ID uniquely identifies an entry (content) or an asset (image, file) in Contentful. To get the entity ID:
Open a content entry in Contentful.
The Entry ID is visible in the entry settings or in the URL when viewing an entry.
Actions Available in ZBrain Flow
1. Search Records
Fetches multiple records from Contentful based on specific query parameters, allowing for efficient retrieval of relevant data.
Configuration Steps:
Select an existing connection or create a new one.
Select the Content Model – Choose the structure of content to search within.
Select the Content Locale – Define the language variation for the search.
Enter the Query Formula – Define conditions to search for records.
Enter the Limit – Specify the maximum number of records to return.
Enter Skip – Set the number of records to skip.
Enter the Relationship include Depth – Define how many levels of linked entries and assets to include.
Return Fields – Specify which fields to return for each record.
2. Get Record
Retrieves a single record from Contentful, useful for obtaining detailed information about a specific entry or asset.
Configuration Steps:
Select an existing connection or create a new one.
Enter the Entity ID – The unique ID of the record to retrieve.
3. Create Record
Creates a new record in Contentful based on a specific content model and locale. You can decide whether to publish the record immediately or keep it as a draft.
Configuration Steps:
Select an existing connection or create a new one.
Select the Content Locale – Choose the language version for the new record.
Select the Content Model – Specify the structure for the new record.
Enable/Disable the 'Publish after creating' Option – Choose whether to publish the record immediately after creation.
4. Custom API Call
Configuration Steps:
Allows direct interaction with Contentful’s API for advanced operations, such as retrieving, updating, or deleting records beyond standard actions.
Select an existing connection or create a new one.
Enter the URL – Use the full API URL or a relative path to the base URL.
Select the HTTP Method:
GET – Retrieve file or folder details.
POST – Upload new files or create folders.
PATCH – Modify file metadata or update folder permissions.
PUT – Replace existing content in a file.
DELETE – Remove a file or folder permanently.
HEAD – Fetch response headers only without retrieving data.
Additional Configurations:
Add Headers – Define additional headers for the API request. Authorization headers are automatically injected. Click ‘+ Add Item’ to include more headers.
Add Query Parameters – Customize API requests with parameters to filter results or add options. Click ‘+ Add Item’ to include more parameters.
Enter JSON Body – Provide structured request data in JSON format.
Set Timeout (in Seconds) – Specify a timeout duration for requests to avoid long-running API calls from causing delays in the process.
Note: Click ‘f’ to insert dynamic values for flexible configurations.
Last updated