thumb-test.png

<h2>What is Automate?</h2>Automate is a user-friendly visual workflow builder designed for business users and developers. It empowers you to effortlessly create and manage complex, multi-step processes through intuitive clicks instead of delving into code. This simplification streamlines the integration of the Contentstack platform&nbsp;into your composable architecture, alleviating the associated technical complexities. <img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/bltf9681be1b6d35416/6625c430700d6cafe6a666b9/AH-image1.png" alt="AH-image1.png" height="auto"/>When someone opts for a headless CMS, they embrace the concept of "composing" a best-of-breed solution for themselves. Composability revolves around the idea of "plug-and-play," but not all competitors in the market offer true composability. This is where Automate sets itself apart.While other headless CMS competitors may provide some degree of automation, their automation is often limited to their CMS only.&nbsp;Contentstack's Automate extends its capabilities across the composable marketplace beyond the CMS.In other words, Automate is the first-ever automation solution that seamlessly integrates and functions across the composable stack! It empowers users to automate tasks within Contentstack's CMS and throughout their entire digital experience ecosystem. By leveraging Automate, users can create dynamic workflows while automating publishing, approvals, archiving, and other content operations without needing custom development. Its intuitive visual workflow builder and pre-built "recipes" enable users to streamline their content operations, regardless of technical expertise, efficiently.<img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/blt190acdddc8aac224/6625c4fb210d90d2483a3240/AH-image2.png" alt="AH-image2.png" height="auto"/><img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/blta8ff7ac243b34016/6625c57424e1812b95acc90a/AH-image3.png" width="auto" alt="AH-image3.png" height="auto" max-width="auto" style="max-width: auto;width: auto;height: auto;"/><h2>Examples</h2><img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/bltf12e36182ffa4624/6625c5afc9de46bfffd472c6/AH-image4.png" alt="AH-image4.png" height="auto"/><h3>Example Use Cases:</h3>Content Enrichment: When content goes into a workflow stage, it executes an Automation to fetch information from external systems to write back to Contentstack. Rapid Prototyping: When you have an idea for a new process or concept, you can play around with it quickly in Automate by pointing and clicking to connect the APIs. Workflow Orchestration: With Automate, you can expand your content lifecycle to define events across the entire business process, not just inside Contentstack, such as marketing campaigns or newsletters.<h3> Simple Automation Script</h3>Let's say you have a blog website and want to automate the publishing process of new blog posts.&nbsp;Your workflow for Automate could look like this:<ol><li>Trigger:&nbsp;When a new entry is created in the "Blog" content type.</li><li>Condition:&nbsp;Check if the blog post's author is in an "Editor" role.</li><li>Action:&nbsp;If the condition is met, automatically set the "Status" of the blog post to "Review."</li><li>Notification:&nbsp;Send an email notification to the "Reviewers" group to review the new blog post.</li><li>Review and Approval:&nbsp;The reviewers can review the blog post, make any necessary changes, and approve it for publishing.</li><li>Action:&nbsp;If the blog post is approved, set the "Status" to "Published."</li><li>Action:&nbsp;If the blog post is rejected, set the "Status" to "Draft" and notify the author for revisions.</li></ol>With this workflow in place, whenever a new blog post is created, the Automate will automatically move the content through the different stages, notify the relevant users, and update the status based on the reviews and approvals.This automation can save time, reduce manual errors, and ensure a smooth content publishing process. Contentstack's Automate empowers users to design and implement customized workflows, tailoring them to meet their organization's specific content management requirements.Another example of an&nbsp;event&nbsp;is when a&nbsp;content entry&nbsp;is&nbsp;published&nbsp;or&nbsp;saved. When an&nbsp;event&nbsp;is triggered, we can use an&nbsp;Automate Connector&nbsp;to integrate with an external platform and perform an&nbsp;action&nbsp;using content from Contentstack. Pre-built&nbsp;Automate Connectors&nbsp;make setting up and configuring the integrations very easy. This course will show many examples of using these&nbsp;Automate Connectors&nbsp;to create integrations with search platforms, email systems, and commerce. <h3>Three reasons to use Automate</h3><ol><li>Integrate apps &amp; tools faster.Reduce integration time with an intuitive visual workflow builder that enables teams to connect Contentstack's CMS to the rest of the tools in their composable stack--all with clicks, not code.- Empower any user to create integrations with an easy-to-use visual editor - Execute complex actions defined by custom event triggers - Leverage pre-built “recipes” to get started quickly - Eliminate costly mistakes &amp; middleware</li><li>Eliminate the headache and costs associated with developing, hosting, and maintaining middleware by managing your integration solutions in one place.- Reduce complexity and increase efficiency by managing all your integrations in one centralized location. - Save money by removing the costs of hosting and managing middleware infrastructure. - Simplify your tech stack by eliminating the need for middleware development. - Streamline content &amp; development operations</li><li>Level up your content ops game and streamline content governance with advanced features that automate content workflows and provide greater visibility and control.- Automate publishing, approvals, archiving, and other content creation workflows. - Push content changes to all of your digital experience channels at once. - Assign advanced permissions and access controls for enterprise-level content governance.</li></ol>Automate ability to traverse the composable stack eliminates the need for costly middleware and offers unparalleled flexibility and efficiency. It opens up new possibilities for organizations to enhance their content operations, achieve faster time-to-market, and unlock the full potential of their digital experience stack.

What is Automate

<h2>Creating a Project in Automate</h2>
When you&nbsp;create a project&nbsp;in Automate within Contentstack, it means you are setting up a dedicated space to manage and execute your automation tasks.
By creating a project, you can automate various content-related tasks, reducing manual effort, improving efficiency, and ensuring consistency in your content management processes.
<h3>Steps to Create a 'New Project' in Automate</h3>1. Log in to your Contentstack account and navigate to the Automate section from the left navigation panel. <img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/blt29d01db612819a0b/6648ba4c16e6bf37bb590c44/automate-section.png" alt="automate-section.png" height="auto" />
 2. Click on the'New Project' button to create a new project.<img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/blt1a56786c25015b54/6648bb616d705597e74d9090/new-project.png" alt="new-project.png" height="auto" /> 3. This opens a dialog box where you can provide a name and description(as optional) for your project. This helps you identify and organize your automation tasks effectively. 4. Click on the&nbsp;'Create'&nbsp;button. 5. After successfully creating the project, you can start building an&nbsp;automation.
<h2>Creating an Automation</h2>Creating a&nbsp;new automation&nbsp;inside a project in Contentstack's Automate allows you to define and set up specific automated tasks or workflows to streamline your content management processes.&nbsp;It helps you set up specific steps that will be performed based on the specified conditions. Once you define these steps, Contentstack Automate will run through the designated steps.
1. Navigate inside the previous&nbsp;project that you created and click on the 'New Automation' button.<img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/blt55529f56aa4828f0/6648bc25d4d02e992a2eab6d/create-project.png" alt="create-project.png" height="auto" /> 2. This opens a dialog box where you can provide a name and description&nbsp;(optional) for your automation.<img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/blt5852cf6e9447a81d/6648bd9352619d711ea90a13/new-automation-dialog.png" alt="new-automation-dialog.png" height="auto" /> 3. Click on the&nbsp;'Create' button. 4. After successfully creating the automation, you can start configuring the trigger&nbsp;and action steps.<img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/blte4704e39fdbc450e/6648bdef5fd9af818c70e24e/trigger-action-sterps.png" alt="trigger-action-sterps.png" height="auto" />

<h2>Limitations of Automate</h2>
<ul>
 <li>
 By default, each organization will be enrolled in the Explorer Plan, which is included at no cost and allows up to 200 executions per month (200 soft cap and 200 hard cap).
 </li>
 <li>
 The maximum number of&nbsp;projects&nbsp;allowed per organization is&nbsp;50.
 </li>
 <li>
 The maximum number of&nbsp;automations allowed per project&nbsp;is&nbsp;50.
 </li>
 <li>
 The maximum number of&nbsp;steps allowed per automation&nbsp;is&nbsp;15.
 </li>
 <li>
 The&nbsp;maximum number of loops per Repeat Path is 100.
 </li>
 <li>
 Currently, organization members can only view and edit their own projects.
 </li>
 <li>
 Currently, organization members can only view and edit their own projects.
 </li>
 <li>
 There is no support for nesting within Conditional Path and Repeat Path steps.
 </li>
 <li>
 The Pause and Response action connectors cannot be used within Conditional Path and Repeat Path steps.
 </li>
 <li>
 Automate is a plan-based feature, and the number of executions allowed depends upon the Automate pricing plan that is activated for a particular organization.
 </li>
 <li>
 Organizations that have upgraded to a paid plan will have a soft cap for executions (when reaching this threshold they will be notified by email), and a hard cap that is 5x the number of the soft cap. After the organization hits the hard cap, automations will be temporarily disabled for that month.
 </li>
</ul>
<h2>Further Reading</h2>
<ul>
 <li>
 <a href="https://www.contentstack.com/docs/developers/automation-hub-guides/create-an-automation/">More about 'Create a New Automation'</a>
 </li>
 <li>
 
 <div><a href="https://www.contentstack.com/docs/developers/automation-hub-guides/edit-automation-details/">Edit an existing Automation</a></div>
 
 </li>
 <li>
 
 <div><a href="https://www.contentstack.com/docs/developers/automation-hub-guides/delete-automation/">Delete an existing Automation</a></div>
 
 </li>
 <li>
 
 <div><a href="https://www.contentstack.com/docs/developers/automation-hub-guides/limitations-of-automation-hub">Automate Limitations - Review maximum number of projects, automations and steps</a></div>
 
 </li>
</ul>

Creating a New Project

First Automate Project Walkthrough

<h1>Exercise Review: Your First Automation Hub Project</h1>1. The Automation Hub Project contains one or more automations. The configuration settings and authorizations are shared within an Automation Hub project.<img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/bltdfe3ff2a3c263cbe/6648c1205c24835191bc345b/er-create-automation.png" alt="er-create-automation.png" height="auto"/>2.&nbsp;The Contentstack Trigger Connector allows us to listen and react to events occurring within the Contentstack UI. For example, the publish entry or save entry events.&nbsp;<img asset_uid="blt84323b82694e0c34" src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/blt84323b82694e0c34/6648c1a5d4d02eecc82eab76/config-trigger.png" alt="config-trigger.png" height="auto"/><img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/blt66a6986f45bfa9df/6648c202acadaf48b07282dc/trigger-types.png" alt="trigger-types.png" height="auto"/>3. The Action step receives the JSON from the Entry in the event and can access the properties of the Entry. &nbsp;<img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/blt7209e595367da050/6648c24e0b508a7d34dcfc62/test-trigger.png" alt="test-trigger.png" height="auto"/><img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/bltd7d3aaaee993018a/6648c2613092d0864a63f98d/test-trigger2.png" alt="test-trigger2.png" height="auto"/>4. Access the content fields of the Entry using the 'body.data.entry' property in the Body of the email. Other connectors allow similar access to the Entry content in the Action step.<img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/blt07960e4f683f1151/6648c2c24ac76e5e0740f842/email-automate.png" alt="email-automate.png" height="auto"/>

Exercise Review: Your First Automation Hub Project

Settings & Options

<img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/blt13fb0843f8d32f85/6648dc36dda14b1dbfdff5d7/types-of-triggers.png" alt="types-of-triggers.png" height="auto"/>In Contentstack,&nbsp;Triggers are conditions or invocation points that begin, or "fire off", an Automation when an event occurs.&nbsp; Events supported include: actions within Contentstack such as a Save or Publish event,&nbsp; scheduled event, receiving a webhook call from an external platform, or deploying an app with the Contentstack Launch product.&nbsp; Triggers and events help automate a business workflow to accomplish required tasks.In the real world,&nbsp;Triggers are like sensors or switches that detect specific events or conditions and initiate a series of actions or workflows in response. They act as the starting point for automation, signaling when something specific happens and prompting the system to perform predefined tasks.<h2>What are Triggers?</h2><ul><li>First, let's look at an analogy.&nbsp; Imagine a scenario with a high-tech security system installed in your house. This system includes motion sensors, door sensors, and cameras, all connected to a central control panel. These are all "triggers" that wait for motion. Then, they send a signal with information about the motion (photo / time / device ID) to the control panel, which serves as the hub for automation and security.&nbsp; After the hub receives the trigger notification, it can perform a series of actions customized by the type of information received - for example, play a small sound for a door sensor or send a video to the cloud for a camera sensor.</li><li>In this scenario, triggers in the Automation Hub can be compared to the various sensors placed throughout your house. When a trigger event occurs, such as a motion sensor detecting movement or a door sensor detecting an unauthorized entry, it sends a signal to the central control panel.</li><li>For instance, if a trigger event is defined to activate when a new article is published, it will automatically initiate a series of actions like sharing the article on social media platforms, sending notifications to subscribers, or updating relevant databases. The trigger serves as the starting point for these actions, ensuring that the appropriate automation processes are set in motion based on the defined events.</li></ul>Triggers in Automation Hub detect specific events or conditions within Contentstack. These events can range from content publishing, content updates,&nbsp; API calls, or scheduled time intervals. When a trigger event occurs, it activates the automation workflow associated with it.<h2>Types of Connection Triggers</h2><img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/blt973d0a0974d50e66/6648dc9f0bbc6203ad7fabbf/types-of-triggers.png" alt="types-of-triggers.png" height="auto"/><ol><li>Contentstack:&nbsp;This connector allows you to create triggers based on content-related events, such as creation, update, publish, or delete actions within Contentstack itself.</li><li>HTTP:&nbsp;The HTTP connector allows you to create triggers based on incoming HTTP requests from external services or applications. You can configure webhooks or receive notifications from external systems.</li><li>Launch:&nbsp;The Launch connector enables you to create triggers based on events within Contentstack's Launch environment. The launch is a product by Contentstack that provides a robust way to manage and deliver content to various digital channels.</li><li>Scheduler:&nbsp;The Scheduler connector enables you to create triggers based on a predefined schedule or time interval. You can set up triggers to execute actions at specific times or recurring intervals.</li></ol>Each connector provides specific functionalities to trigger actions based on different events or conditions within Contentstack or external systems. We will explore them in detail very soon.

Understanding Triggers

Using Trigger Connectors

<h1>Understanding Connectors&nbsp;</h1>Connectors in Automation Hub understand different systems' specific requirements and capabilities, whether content management systems, marketing automation platforms, or third-party services.<h2>What are Connectors?</h2>Connectors&nbsp;are like bridges that connect different systems and enable smooth communication and data flow between them. They act as intermediary components that facilitate the exchange of information, triggering actions, and automating processes.<h2>Example</h2><ul><li>Imagine you have a large city with multiple transportation systems like roads, railways, and airports. Each system operates independently and has its own unique functions and rules. However, for efficient transportation and logistics, you need a way to connect these systems and enable the smooth movement of people and goods.</li><li>In this scenario, connectors in the Automation Hub are like well-designed interchanges, terminals, and transfer points that ensure a seamless flow of traffic between the different transportation systems. They understand the needs and protocols of each system and provide a standardized interface for the vehicles to enter, exit, and transfer between them.</li></ul>

Using Connectors

Action Connectors

<h2>Automate Connectors</h2>Automation Hub&nbsp;connectors&nbsp;are third-party applications that you can use with Automation Hub to automate certain tasks. Here are a few connectors you can set up quickly and use in an automation.<img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/blt450a11a187293158/6648df3f015b1c5aaa56ef88/automate-connectors.png" alt="automate-connectors.png" height="auto"/>Here are some examples of actions you can perform in Contentstack's Automation Hub:<ul><li>Update Content:&nbsp;Imagine you have a library, and when new books arrive, your librarian automatically updates the catalog with the book's information, including its title, author, and genre. Similarly, the "Update Content" action in Contentstack automatically modifies specific fields or attributes of a content entry when triggered.</li></ul> <img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/bltd5d421643619410c/6648dfa60a0de6ffe5314ce9/update-entry.png" alt="update-entry.png" height="auto"/>Publish Content:&nbsp;Think of a newspaper editor who, upon finalizing an article, presses a button to send it for printing and distribution to the subscribers. In Contentstack, when triggered, the "Contentstack Action - Publish Content" automatically publishes content to your website, mobile app, or any other digital channels.&nbsp; For example, the Trigger may be Entry Update, so every time an Entry is saved. the Automation Hub re-publishes the content to an 'Instant Preview' frontend site.&nbsp;<img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/blt3fb4550b9d2c404f/6648dfe34ac76e417540f869/publish-entry.png" alt="publish-entry.png" height="auto"/>Notify Team:&nbsp;Consider a fire alarm system in a building that detects smoke or fire and immediately alerts the building occupants with loud sirens and flashing lights. Similarly, the "Email by Automation Hub" and "Slack" actions in Automation Hub send notifications or alerts to designated team members, such as sending an email or a message in a collaboration tool like Slack, when a trigger event is detected.<img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/blt01249a627ac710d3/6648e00d0a0de65c88314ced/communicate.png" alt="communicate.png" height="auto"/>Create Task:&nbsp;Picture a project manager who wants to create a Jira task when an item is assigned in Workflow.&nbsp; When an Entry is set to a workflow stage in Contentstack, an Automation is triggered to create a new Jira task.&nbsp; In Contentstack, when triggered, the&nbsp;<a href="https://www.contentstack.com/docs/developers/automation-hub-connectors/jira/">"JIRA" action</a>&nbsp;generates new tasks or assigns tasks to team members in Jira and works together with the content workflow.<img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/blt472505ba83ebeb1f/6648e04916e6bf7142590c5b/choose-connector.png" alt="choose-connector.png" height="auto"/><img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/blt2bd9a0b07a06bf3b/6648e0674284321e941989a0/connector-detail.png" alt="connector-detail.png" height="auto"/>

Automate Connectors

<h2>Types of Action Connectors</h2>In Contentstack's Automation Hub, several types of action connectors are available. These action connectors allow you to define specific tasks or operations to be executed when a trigger event occurs.&nbsp; &nbsp;Each connector represents a specific integration or service that can perform actions in your automation workflows.Each connector receives JSON from the previous steps and can use a&nbsp;<a href="https://www.contentstack.com/docs/developers/automation-hub-connectors/transform">Transform connector</a>&nbsp;to massage or directly consume the data. If you want to connect to a service not listed here, then the&nbsp;<a href="https://www.contentstack.com/docs/developers/automation-hub-connectors/http-action">HTTP Action</a>&nbsp;can send JSON to any 3rd-party web service.<a href="https://www.contentstack.com/docs/developers/automation-hub-connectors">Here are the types of action connectors in Contentstack's Automation Hub</a>:<img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/blt61d6e1debdf89919/6648e12516e6bf4543590c61/types-of-connectors.png" alt="types-of-connectors.png" height="auto"/><ol><li>CMS:<ul><li>Contentstack Action:&nbsp;Performs content-related actions such as&nbsp;'Get All Content Types,' 'Get All Entries,' 'Delete an Entry,' 'Add Items to a Release,' 'Clone a Release,' 'Create a Release,' 'Delete Items from a Release,' 'Deploy a Release,' 'Get All Items in a Release,' 'Get All Releases,' 'Get Single Release,' 'Get User Information,' 'Create an Entry,' 'Entry Workflow Stage,' 'Localize an Entry,' 'Publish an Entry,' 'Publish an Asset,' 'Unpublish an Entry,' 'Get Single Entry,' 'Update Entry.'</li></ul></li><li>CI/CD Platform:<ul><li>CircleCI,&nbsp;TravisCI:&nbsp;Integrates with CircleCI, TravisCI for continuous integration and delivery workflows.</li></ul></li><li>Communication:<ul><li>Email by Automation Hub:&nbsp;Sends emails as an action within Contentstack's Automation Hub.</li><li>Mailgun:&nbsp;Integrates with the Mailgun email service for sending emails.</li><li>PubNub:&nbsp;Integrates with the PubNub platform for real-time messaging and communication.</li><li>Pusher:&nbsp;Integrates with Pusher for real-time push notifications.</li><li>SendGrid:&nbsp;Integrates with SendGrid for sending emails.</li><li>Slack:&nbsp;Sends messages or notifications to Slack channels or users.</li><li>Twilio:&nbsp;Integrates with Twilio for SMS and voice communication.</li></ul></li><li>Artificial Intelligence:<ul><li>ChatGPT:&nbsp;Uses OpenAI's ChatGPT for AI-powered chatbot capabilities.</li></ul></li><li>Digital Asset Management:<ul><li>Cloudinary:&nbsp;Integrates with Cloudinary for digital asset management and manipulation.</li><li>Aprimo:&nbsp;Integrates with Aprimo's digital asset management platform.</li></ul></li><li>eCommerce:<ul><li>BigCommerce:&nbsp;Integrates with the BigCommerce eCommerce platform.</li></ul></li><li>FaaS (Function-as-a-Service):<ul><li>AWS Lambda:&nbsp;Executes serverless functions on the AWS Lambda platform.</li></ul></li><li>Hosting:<ul><li>Launch:&nbsp;Performs actions within Contentstack's Launch environment.</li><li>Heroku:&nbsp;Integrates with Heroku for application hosting and deployment.</li><li>Netlify:&nbsp;Integrates with Netlify for static website hosting and deployment.</li><li>Vercel:&nbsp;Integrates with Vercel for static website hosting and deployment.</li></ul></li><li>Development:<ul><li>Code Block:&nbsp;Executes custom code or scripts as an action within Contentstack's Automation Hub.</li></ul></li><li>Database:<ul><li>Airtable:&nbsp;Integrates with Airtable, a collaborative database and project management tool.</li></ul></li><li>Messaging Queue:<ul><li>AWS SQS:&nbsp;Integrates with AWS Simple Queue Service for messaging and queuing capabilities.</li></ul></li><li>Notification Service:<ul><li>AWS SNS:&nbsp;Integrates with AWS Simple Notification Service for sending notifications to various endpoints.</li></ul></li><li>Project Management:<ul><li>Jira:&nbsp;Integrates with the Jira project management tool.</li></ul></li><li>Translation Platform:<ul><li>Smartling:&nbsp;Integrates with Smartling, a translation management platform.</li></ul></li><li>Search &amp; Discovery:<ul><li>Algolia:&nbsp;Integrates with Algolia for search and discovery capabilities.</li><li>Constructor:&nbsp;Integrates with Constructor for site search and search analytics.</li><li>Elasticsearch:&nbsp;Integrates with Elasticsearch for powerful search and indexing capabilities.</li></ul></li><li>Storage:<ul><li>AWS S3:&nbsp;Integrates with AWS Simple Storage Service for storing and retrieving files and objects.</li></ul></li><li>Storage:<ul><li>AWS S3:&nbsp;Integrates with AWS Simple Storage Service for storing and retrieving files and objects.</li></ul></li><li>Utility:<ul><li>Data Store:&nbsp;This helps you store keys and their corresponding values within a database that you can retrieve later. With the Data Store connector, you can also store and fetch the data stored during execution.</li><li>HTTP Action:&nbsp;This enables you to perform HTTP requests as an action within Contentstack's Automation Hub. You can send HTTP GET, POST, PUT, DELETE, or PATCH requests. This connector is valuable for integrating with external systems or triggering actions in other applications.</li><li>Pause:&nbsp;This lets you pause existing automation.</li><li>Transform:&nbsp;Helps in manipulating texts and numbers as required. It helps you to manipulate and structure data according to your needs. For example, suppose in the previous trigger; specific data is selected to be displayed. In that case, the action defined by the Transform connector can manipulate or change to meet your display requirements.</li><li>Response:&nbsp;Helps determine the status of your configured action. It notifies users about the success or failure of a configured action with a response.</li><li>RTE Formatter:&nbsp;Helps convert content within the JSON Rich Text Editor into HTML or text formats.</li><li>Utility:&nbsp;Helps to manage your automation workflow. With the wait action, you can put your automation on hold for some time before the following automation action runs. </li></ul></li></ol>

Types of Action Connectors

Automations in Marketplace

Using Trigger Conditions to Control an Automate Execution

Using Conditionals When Publishing to Production

Using the HTTP Connector with a Publish Event

Using HTTP Listeners

<h1>HTTP Listener</h1>The&nbsp;HTTP Listener&nbsp;connector allows you to create automated workflows to&nbsp;receive incoming HTTP requests&nbsp;and trigger specific actions based on the received data. This endpoint listens to incoming HTTP requests and processes them according to your workflow.&nbsp; An HTTP endpoint is provided that an external platform or external webhook can use and send JSON data to Automation Hub.<img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/blt8c471a1cdcd30f3e/664947c35c248385cfbc34f9/http-listener2.png" alt="http-listener2.png" height="auto"/><h2>Example</h2>Here's an example to illustrate the use of the HTTP Listener connector:Let's say you have an e-commerce website, and you want to trigger an automation workflow whenever a new order is received through an API call.<ol><li>Set up the HTTP connector&nbsp;-<ul><li>In Automation Hub, select the "HTTP" connector.</li></ul></li><li>Configure the HTTP trigger -<ul><li>Configure the HTTP method (e.g., POST) trigger&nbsp;and define any required authentication or headers.</li><li>Define the specific endpoint or route corresponding to the URL generated for the order creation API call.</li><li>Set any required headers or parameters to match your API requirements.</li></ul></li><li>Define subsequent actions -<ul><li>Once the HTTP connector trigger receives the HTTP request, you can define subsequent actions in the workflow.</li><li>Add actions such as validating the order, updating inventory, sending confirmation emails, or integrating with other systems.</li></ul></li><li>Test and deploy the workflow -<ul><li>Test the workflow by simulating an API call to the defined endpoint and verifying that the trigger is activated.</li><li>Ensure that the subsequent actions in the workflow, such as order processing and system integration, are executed as expected.</li><li>Once tested, activate the workflow and&nbsp;be ready to process incoming API requests.</li></ul></li></ol>In this example, the HTTP connector acts as a trigger, allowing you to listen for incoming API calls and initiate the defined automation workflow. You can perform various actions within the workflow based on the received order data, such as updating databases, triggering notifications, or performing business logic.Using the HTTP connector as a trigger provides flexibility in integrating external systems or services with Contentstack's Automation Hub. You can easily automate processes, streamline data flows, and orchestrate complex workflows by leveraging the HTTP connector's ability to listen for incoming HTTP requests.

Understanding HTTP Listeners

<h1>Scheduled Jobs</h1>The&nbsp;Scheduler by Automate&nbsp;connector in Contentstack allows you to schedule and automate tasks or workflows at specific times or intervals. It acts as a trigger to initiate an automation workflow based on the defined schedule.<img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/blt63e0fdbddb2882fe/66494833342fb531a162ccc5/scheduled-jobs.png" alt="scheduled-jobs.png" height="auto"/>Let's consider a scenario where you want to send a daily email newsletter to your subscribers at a specific time using Contentstack's Automate:<ol><li>Set up the 'Scheduler by Automate' connector and trigger -<ul><li>In Automation Hub, select the 'Scheduler By Automate' connector.</li><li>Configure the scheduler trigger by specifying the Time Zone and Unix Cron Pattern.&nbsp;Specify the exact time or interval you want the automation workflow to be triggered.</li></ul></li><li>Define subsequent actions -<ul><li>Once the scheduler trigger activates the workflow, you can define subsequent actions.</li><li>Add actions to generate the email newsletter content, fetch subscriber data, and send personalized emails.</li></ul></li><li>Test and deploy the workflow -<ul><li>Test the workflow by manually triggering it or waiting for the scheduled time.</li><li>Verify that the workflow executes as expected, generating and sending the email newsletters to subscribers.</li><li>Once tested, activate the workflow and&nbsp;automate the daily email newsletter process.</li></ul></li></ol>In this example, the Scheduler by Automation acts as a trigger, allowing you to schedule the execution of a workflow at specific times or intervals. The automation workflow can perform various actions, such as generating dynamic content, fetching data from external sources, and sending emails to subscribers.Using Scheduler by Automation, you can streamline recurring tasks, automate time-based processes, and ensure consistent and timely execution of workflows within Contentstack's Automate.

Understanding Scheduler by Automate

<h1>Launch Connector</h1>The&nbsp;Launch&nbsp;connector&nbsp;is a feature that allows you to initiate deployments of websites hosted on the Contentstack-powered jamstack platform called "Launch." Whether your website's content is managed by a different CMS (headless or traditional), you can use Launch to quickly host such sites.&nbsp;You can easily trigger deployments by creating a new project in Launch and connecting it to your GitHub or GitLab repository. This seamless integration streamlines the deployment process for your websites, making it efficient and hassle-free.<h2>Launch Connector for Action</h2><img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/bltdda2557e6e507603/66494908efc97a69cb4c0ac4/launch-connector.png" alt="launch-connector.png" height="auto"/>Let's consider an example where&nbsp;the team sets up a scheduled job to automatically deploy new code builds for your website at midnight every Sunday by&nbsp;using the Scheduled Jobs Trigger with Launch Action Connector:<ol><li>Set up the 'Scheduler by Automate' connector and trigger -<ul><li>In Automate, select the 'Scheduler By Automate' connector.</li><li>Configure the scheduler trigger by specifying the Time Zone and Unix Cron Pattern.&nbsp;Specify the exact time or interval you want the automation workflow to be triggered. Here, at midnight every Sunday.</li></ul></li><li>Define 'Launch Connector' action&nbsp;-<ul><li>Once the scheduler trigger activates the workflow, you define the Launch connector in the action.</li><li>This action deploys the build for the authorized and selected Launch project.</li></ul></li><li>Test and deploy the workflow -<ul><li>Test the workflow by manually triggering it or waiting for the scheduled time.</li><li>Verify that the workflow executes as expected, deploying the build to the set environment.</li><li>Once tested, activate the workflow&nbsp;and automate your website build deployment.</li></ul></li></ol>This approach proves beneficial as the team can confidently plan and execute updates without disrupting the website's live performance.<h2>Launch Connector for Trigger</h2><img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/blt1d6b0a82057555c3/664949670b508aef4fdcfd1e/launch-connector-for-trigger.png" alt="launch-connector-for-trigger.png" height="auto"/>Let's consider an example where we set up 'Launch as the trigger' for the automation. Whenever a deployment on Launch fails, the automation automatically sends an email notification to a designated group of users using the 'Email by Automate' action connector:<ol><li>Set up the 'Launch' connector and trigger -<ul><li>In Automate, select the 'Launch' connector.</li><li>Configure the 'Deployment' trigger where you select the event as&nbsp;'Deployment&nbsp;failed'&nbsp;for the selected Launch project.</li></ul></li><li>Define 'Email by Automate' action&nbsp;-<ul><li>Once the scheduler trigger activates the workflow, you define the 'Email by Automate' connector in the action.</li><li>This action will email the list of users(specified during the setup) when the Launch deployment fails.</li></ul></li><li>Test and deploy the workflow -<ul><li>Test the workflow by manually triggering it or deploying the Launch project.</li><li>Verify that the workflow executes as expected, deploying the build to the set environment.</li><li>Once tested, activate the workflow&nbsp;and automate your website build deployment status.</li></ul></li></ol>This example demonstrates how Automate can be used to proactively notify the team about deployment issues, allowing them to address and resolve any potential challenges promptly.

Launch Connector

<h2>Data Store Connector</h2>The Data Store connector in Automate provides a convenient way to store key-value pairs within the Contentstack database. These key-value pairs can be used to store any data you want to retrieve and use later in your automation workflows. The Data Store connector allows you to store data during the execution of automation and fetch it when needed.<img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/blt93f2a8b94bd49abf/66494a0f4ac76e5d8f40f8fc/data-store.png" alt="data-store.png" height="auto"/>Key Features of the Data Store Connector:<ol><li>Data Storage -&nbsp;The Data Store connector can store data as key-value pairs. Each pair consists of a unique key and its corresponding value. The data stored can be of any type, including strings, numbers, booleans, and even complex data structures like objects or arrays.</li><li>Data Retrieval -&nbsp;Once data is stored using the Data Store connector, you can retrieve it later within the same automation or across different workflow steps. This lets you pass data between different actions and conditions, making your automation more dynamic and versatile.</li><li>Persistent Storage -&nbsp;The data stored using the Data Store connector is persistently saved within the database. This means that even if the automation execution is paused or stopped, the data will still be available when the execution resumes.</li><li>Instance-Specific Data -&nbsp;The Data Store connector allows you to store and fetch data specific to the current instance of an automation execution. This enables you to manage data at the instance level and avoids conflicts or data interference between different executions of the same automation.</li></ol>Use Cases of the Data Store Connector:<ol><li>Configuration Management -&nbsp;You can use the Data Store connector to store configuration settings, such as API keys, credentials, or connection details, that need to be accessed by multiple actions or steps within automation.</li><li>Data Transfer and Transformation -&nbsp;The Data Store connector can transfer data between different automation steps. For example, you can store data in one step and fetch it later to perform transformations or calculations in subsequent steps.</li><li>State Management -&nbsp;If your automation involves multiple conditional branches or loops, the Data Store connector can help manage the automation's state by storing and updating relevant data as the automation progresses.</li><li>Error Handling and Recovery -&nbsp;The Data Store connector can store error messages or status flags during the execution of automation. This can aid in error handling and recovery strategies.</li></ol>In summary, the Data Store connector in Automate provides a flexible and efficient way to store and retrieve data within your automation workflows. It enables you to create more sophisticated and data-driven automations, enhancing efficiency and productivity in your processes.<h1>HTTP Action Connector</h1>An HTTP action connector is a utility connector that interacts with external services, APIs, or web endpoints using the Hypertext Transfer Protocol (HTTP). You can send HTTP requests (such as GET, POST, PUT, DELETE) to remote servers, receive responses, and potentially process or transform the data through this connector.<img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/bltf8395252dca738e0/66494a5b0bbc628ea47fac08/http-connector.png" alt="http-connector.png" height="auto"/>Key Features of an HTTP Action Connector:<ul><li>HTTP Methods -&nbsp;Supports various HTTP methods like GET, POST, PUT, and DELETE, allowing you to interact with different parts of an API.</li><li>Request Configuration -&nbsp;You can configure headers, query parameters, request body, and other settings required for the API request.</li><li>Response Handling -&nbsp;Typically, you can extract data from the response, handle status codes, and parse the returned data (often in JSON or XML format).</li><li>Authentication -&nbsp;Supports various authentication mechanisms, such as API keys, OAuth tokens, or basic authentication.</li><li>Error Handling -&nbsp;Provides options to handle errors, retries, and timeouts to ensure robust interactions with the API.</li><li>Customization -&nbsp;Allows you to customize and manipulate the data before sending the request or after receiving the response.</li></ul>Use Cases for HTTP Action Connectors in Utility Connectors:<ol><li>Data Integration -&nbsp;You can use the HTTP action connector to fetch data from external sources like APIs and synchronize it with your Contentstack content. For example, automatically pulling data from a third-party system and updating content entries.</li><li>Third-Party Services -&nbsp;Integrate with third-party services like email platforms, messaging services, or social media APIs to trigger actions based on content changes.</li><li>Content Enrichment -&nbsp;Utilize external services to enrich your content. For instance, automatically tagging content with relevant keywords using a natural language processing API.</li><li>Webhooks: Receive and process data from external sources through webhooks. The HTTP action connector can parse and handle incoming webhook payloads.</li><li>Content Delivery: Trigger HTTP requests to deliver content to external systems. This could involve publishing content to a website or an external database.</li><li>Data Migration: Use the HTTP action connector to migrate content from one system to another by sending appropriately formatted API requests.</li></ol>In summary, An HTTP action connector is a tool in workflow automation platforms that lets you interact with external services via HTTP requests. In Contentstack Automate, it can help integrate data, trigger actions based on content changes, enrich content, manage webhooks, deliver content, and handle data migration.<h1>Utility Connector - Wait Action</h1>The Utility action connector helps to manage your automation workflow. With the wait action, you can put your automation on hold for some time before the following automation action runs.You can set up three actions: Wait, Continue Automation If, and Continue Repeat If.<img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/blt1902cd2c8600e1b4/66494ade0bbc6207ac7fac0c/wait-action1.png" alt="wait-action1.png" height="auto"/><h2>Example: Wait connector in Repeat Path</h2>Let’s see a simple use-case of the Utility connector using Repeat Path.Wait action is useful while working with bulk data. Previously, if the number of API requests exceeded the defined limitation, the automation failed automatically due to rate limiting.In this example, we are sending bulk data through the HTTP action with a limitation of 5 API requests per second, and we will use the Wait action to delay the API request per second to create multiple entries in Contentstack. We will also see how the user receives an error message in the Execution Log section for exceeding the rate limit.<img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/bltd87d2c9ea470f3bc/66494b00b2e852f9f0451976/wait-action2.png" alt="wait-action2.png" height="auto"/>For examples of every Utility option, please see the&nbsp;<a href="https://www.contentstack.com/docs/developers/automation-hub-connectors/utility" target="_self">Automate Utility documentation</a>.<h2>Transform</h2>Transform does exactly what it sounds like - transforming data from one format to another. More specifically, it allows the developer to specify the JSON format that will be passed to a future Automation step and use the data and properties from Entries or other objects and properties available.For example, our external system expects a JSON object with a title, content property, and date. Using Transform, we can create a new JSON object with only 3 properties and fill in the data from Contentstack objects in the Automation.In the screenshot below, we are creating a new JSON object with a property called 'result' containing the value of the Entry's name field capitalized.<img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/blt0b5daaf2141713c8/66494b574b531e4547c328ba/transform2.png" alt="transform2.png" height="auto"/><img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/blt8d241b3597b12963/66494b57015b1c360b56effa/transform1.png" alt="transform1.png" height="auto"/>

Utility Connectors

Use Case: Translation with ChatGPT

Automate is a user-friendly visual workflow builder designed for business users and developers. It empowers you to effortlessly create and manage complex, multi-step processes through intuitive clicks instead of delving into code. This simplification streamlines the integration of the Contentstack platform&nbsp;into your composable architecture, alleviating the associated technical complexities.Pre-requisites: 1. Account in Contentstack with access to a Stack as an Administrator or Developer. If possible, please create a new Stack to use only with the Partner Courses.2. A basic comprehension of the Contentstack platform, extensions, and integrations.3. Comfortable taking a screenshot or a movie of your screen. The free browser tool 'Loom' is one of many ways to do this.4. Contentstack Community account. If you do not have one, visit&nbsp;community.contentstack.com/&nbsp;and register for a new account. You can adjust your email notifications under your profile at&nbsp;https://community.contentstack.com/settings/general&nbsp;﹥ Settings.

Automate Fundamentals

Automate Foundations Thumbnail

Automate Foundations

Discord: <a href="https://discord.com/invite/NyWJ68gdDw">https://discord.com/invite/NyWJ68gdDw</a>

PIM Basics

Opengraph_B.png

A Simple PIM Setup for Contentstack

A Simple PIM Setup for Contentstack Coding Thumbnail

Discord: <a href="https://discord.com/invite/NyWJ68gdDw">https://discord.com/invite/NyWJ68gdDw</a><a href="https://www.contentstack.com/docs/developers/set-up-visual-builder">Visual Builder Documentation for Developers</a>

Visual Builder Data Modeling Best Practices

Opengraph_A.png

Visual Builder Data Modeling Best Practices Coding Thumbnail

Search 2.0

This video describes the search capabilities within the Contentstack CMS

Learn how to search in Contentstack

Using Search Explainer Thumbnail

Using Search

Master the art of searching with Contentstack Academy's guide and learn to efficiently find and filter content with advanced search techniques.

Cs Intro-to-cs-teams-and-taxonomy V1 4.19.24

A small group demo on Contentstack's Teams and Taxonomy feature.

Teams and Taxonomy Demo

Teams And Taxonomy Webinar Thumbnail

Teams & Taxonomy Webinar

Cs Intro-to-live-preview V1 3.22.24

In this webinar we review the benefits of having Live and Release preview in the Contentstack CMS.

Live and Release Preview Webinar 

Live Preview And Release Preview Webinar Thumbnail

Live Preview & Release Preview Webinar

Discover how Timeline allows you to navigate through time to see how your future content changes will appear, compare different stages of updates, and collaborate on upcoming changes—all within Contentstack.

Cs Intro-to-timeline V1 7.19.24

Discover how Timeline allows you to navigate through time to see how your future content changes will appear, compare different stages of updates, and collaborate on upcoming changes—all within Contentstack.

Timeline: A better way to visualize and plan future content updates

Timeline Webinar Thumbnail

Timeline Webinar

Cs Ai-custom-action-demo V1 5.17.24

AI Assistant Custom Actions

AI Assistant Custom Actions Webinar Thumbnail

<h2>Introduction to Taxonomy in Content Management</h2>
Welcome to the&nbsp;Taxonomy course in Contentstack! This module will explore how taxonomy is crucial in organizing and managing content within your digital ecosystem.
<h2>Understanding Taxonomy</h2>
Taxonomy helps you categorize pieces of content within your stack to facilitate easy navigation, search, and retrieval of information. You can hierarchically organize your web properties based on your requirements, such as their purpose, target audience, or any other aspects of your business.
This systematic organization gives developers and content managers complete control over their content and helps users find relevant content more efficiently, thus improving the overall user experience.
<h2>Key Features of Taxonomy</h2>
Let's delve into the key features of Taxonomy as they apply to Contentstack:
<ol>
 <li>
 
 Structured Hierarchy:&nbsp;Taxonomies arrange terms in a hierarchical structure, simplifying the categorization and navigation of information.
 
 </li>
 <li>
 
 Categorization and Classification:&nbsp;With taxonomy, you can categorize and classify entries using terms, enabling you to group similar content elements together logically.
 
 </li>
 <li>
 
 Enhanced Search Efficiency:&nbsp;By narrowing down search results to relevant categories, taxonomy enhances search efficiency, allowing users to find the content they need quickly and effortlessly.
 
 </li>
 <li>
 
 Use the APIs to retrieve Entries tagged with Taxonomy terms in the frontend web application.
 
 </li>
</ol>
<h2>Role-based Advantages</h2>
Now, let's explore how Taxonomy benefits different roles within your organization:
<ol>
 <li>
 
 Content Managers:&nbsp;Taxonomy significantly enhances content organization and navigation for content managers. They can categorize and manage content across multiple types, making locating and maintaining specific content easier.
 
 </li>
 <li>
 
 Developers:&nbsp;For developers, Taxonomy offers a structured approach to organizing content facilitating the building and maintenance of website content. Developers can access content based on taxonomy terms using the APIs, allowing more advanced queries with the Content Delivery API.
 
 </li>
 <li>
 
 Content Editors:&nbsp;Taxonomy streamlines workflow for content editors, allowing them to navigate and categorize content intuitively due to the hierarchical structure. This boosts productivity and reduces the time spent searching for specific content.
 
 </li>
</ol>

<h2>Real-World Example: E-commerce Product Taxonomy</h2>
Imagine you are managing an e-commerce platform that sells a wide range of products, from electronics to clothing. Let's apply the principles of taxonomy to organize the product catalog effectively.
1. Structured Hierarchy:
<ul>
 <li>
 Category:&nbsp;Electronics
 <ul>
 <li>
 Subcategories:&nbsp;Smartphones, Laptops, Cameras
 </li>
 </ul>
 
 </li>
 <li>
 Category:&nbsp;Clothing
 <ul>
 <li>
 Subcategories:&nbsp;Men's Clothing, Women's Clothing, Kids' Clothing
 </li>
 </ul>
 
 </li>
 <li>
 Category:&nbsp;Home &amp; Kitchen
 <ul>
 <li>
 Subcategories:&nbsp;Furniture, Appliances, Cookware
 </li>
 </ul>
 
 </li>
</ul>
2. Categorization and Classification:
<ul>
 <li>
 Within the "Smartphones" subcategory, products can be further classified based on brands such as Apple, Samsung, or Google.
 </li>
 <li>
 In the "Men's Clothing" category, items can be categorized by type, including shirts, pants, and accessories.
 </li>
</ul>
3. Enhanced Search Efficiency:
<ul>
 <li>
 A user searching for "Samsung smartphones" can quickly find relevant products within the "Smartphones" category under the "Electronics" section, narrowing down search results.
 </li>
 <li>
 Similarly, searching for "men's shirts" will lead users to the appropriate category within the "Clothing" section.
 </li>
</ul>

Taxonomy in Content Management

Welcome to Taxonomy

If you have not yet configured Postman to work with the Academy training instance, this module will help you download and setup the Contentstack Postman collections.
1.&nbsp;<a href="https://www.contentstack.com/docs/developers/apis/postman-collections">Download the Postman collections</a>
2.&nbsp;<a href="https://www.contentstack.com/docs/developers/apis/postman-collections">Download and install the Environment files for both Content Management and Content Delivery</a>
3. Create a&nbsp;<a href="https://www.contentstack.com/docs/developers/create-tokens/create-a-delivery-token">Delivery Token</a>&nbsp;for Preview and Production
4.&nbsp; Create a&nbsp;<a href="https://www.contentstack.com/docs/developers/create-tokens/generate-a-management-token">Management Token</a>

Configuring Postman with the Contentstack APIs

Using Postman and APIs in Contentstack

Introduction:&nbsp;In this module, you will learn how to create a taxonomy within Contentstack to effectively organize and structure your website's content.
Understanding Taxonomy:&nbsp;Taxonomies enable efficient content management and retrieval.&nbsp; Centrally managing taxonomies allow organizations to classify their content in a structured manner, enabling them to easily find content and also retrieve content based on the taxonomy and terms applied.&nbsp; In this course, we will look at how we can use taxonomies in Contentstack to structure and organize our content.
Step-by-Step Guide:
<ol>
 <li>
 
 Accessing Taxonomy Settings:
 <ul>
 <li>
 Log in to your Contentstack account.
 </li>
 <li>
 Navigate to the desired stack where you want to create a taxonomy.
 </li>
 <li>
 Click on the "Settings" icon (shortcut: press "S") located on the left navigation panel.
 </li>
 <li>
 Select "Taxonomy" from the settings menu. 
 </li>
 </ul>
 
 </li>
</ol>
<img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/bltff4db51667495e31/6649053a4bfb7158ef42c0f1/new-taxonomy.png" alt="new-taxonomy.png" height="auto" />

<ol>
 <li>
 
 Creating a New Taxonomy:
 <ul>
 <li>
 Once in the Taxonomy section, click on the "+ New Taxonomy" button.
 </li>
 <li>
 Enter a Name for your taxonomy. Please note that the Unique ID will be auto-generated and can be edited until the taxonomy is saved. Once saved, the UID cannot be changed.
 </li>
 <li>
 Optionally, you can add a 'Description' of your taxonomy to provide additional context.
 </li>
 <li>
 Click on "Create Taxonomy" to finalize the creation process.
 </li>
 </ul>
 
 </li>
</ol>
<img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/bltcb31202438264335/6649059b16e6bf7617590c83/new-dialog.png" alt="new-dialog.png" height="auto" />


Adding Terms to the Taxonomy:
<ul>
 <li>
 Within your newly created taxonomy, you can begin adding terms associated with the taxonomy.
 </li>
 <li>
 For example, if your taxonomy is based on "Superhero," you can create terms such as "Natural Powers," "Mystic Origins," "Scientific Experimentation," "Super Strength," etc.
 </li>
 <li>
 This step allows you to further organize and classify your content based on specific criteria.
 </li>
</ul>

<img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/blt1cafb7dd805ee8bb/664905e8d4d02ee5f02eaba3/terms.png" alt="terms.png" height="auto" />Conclusion:&nbsp;Congratulations! You have successfully learned how to create a taxonomy within Contentstack to organize and structure your website's content. By leveraging taxonomies, you can enhance the usability and navigation of your website, providing users with a seamless browsing experience. Don't forget that&nbsp;you can also create taxonomies programmatically using the&nbsp;<a href="https://www.contentstack.com/docs/developers/apis/content-management-api#taxonomy">Create a Taxonomy API request</a>&nbsp;for added flexibility and automation.

Creating a Taxonomy

Creating a Taxonomy Walkthrough

After we create a Taxonomy we&nbsp; need to add it to a Content Type before we can start using it.&nbsp; To do that, we will need to edit an existing Content Type and add a new Taxonomy field.&nbsp; Currently, Contentstack allows one Taxonomy field per Content Type, and within this field it is possible to select one or more taxonomies to use for selecting and adding terms to the Entry.&nbsp; Let's take a look at a practical example to understand how we can add our Taxonomy to our Content Type.&nbsp;
1.&nbsp; Navigate to the Content Models window and edit the&nbsp;Character Content Type.
2.&nbsp; Add a new Taxonomy field<img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/bltf9b6eb87c30d5f53/6649073a0a0de6d1a2314d19/taxonomy-content-type.png" alt="taxonomy-content-type.png" height="auto" />3. Select the Superhero Taxonomy&nbsp;

<img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/blt023a2d4f291d753e/664907705c2483f6a6bc3484/superhero-taxonomy.png" alt="superhero-taxonomy.png" height="auto" />4. Save the Content Type

Using the Taxonomy in a Content Type

Using a Taxonomy to a Content Type Walkthrough

Welcome to the module on editing taxonomies within Contentstack! This module will explore how to easily modify your taxonomies to suit your evolving content organization needs.
Overview
Once you've created a taxonomy, you may need to make adjustments, such as updating its name or description. This module will guide you through the steps to edit a taxonomy efficiently.
Accessing Taxonomies
To begin editing a taxonomy, follow these steps:
<ol>
 <li>
 
 Log in:&nbsp;Access your Contentstack account.
 
 </li>
 <li>
 
 Navigate to Settings:&nbsp;On the left navigation panel, click on the "Settings" icon (shortcut: press "S").
 
 </li>
 <li>
 
 Select Taxonomy:&nbsp;Within the Settings section, choose the "Taxonomy" option.
 
 </li>
</ol>
Editing a Taxonomy
Once you've accessed the Taxonomy section, follow these steps to edit a taxonomy:
<ol>
 <li>
 
 Locate the Taxonomy:&nbsp;Identify the taxonomy you wish to edit from the list displayed.
 
 </li>
 <li>
 
 Access Edit Options:&nbsp;In the Actions column for the respective taxonomy, click on the ellipsis (three dots) icon.
 
 </li>
 <li>
 
 Initiate Editing:&nbsp;Select the "Edit" button from the options provided.
 
 </li>
</ol>
<img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/blted5a3726271be0d9/6649083e42843219ee1989c5/edit-taxonomy.png" alt="edit-taxonomy.png" height="auto" />
Making Changes
In the Edit Taxonomy modal, you can modify the following aspects of the taxonomy:
<ul>
 <li>
 Taxonomy Name:&nbsp;Update the name of the taxonomy to reflect any changes in its purpose or scope.
 </li>
 <li>
 Description:&nbsp;Edit or add a description to provide context or additional information about the taxonomy.
 </li>
</ul>
Please note: The Taxonomy UID cannot be edited once the taxonomy is created.
Saving Changes
Once you've made the necessary edits, click the "Update" button in the Edit Taxonomy modal to save your changes.
<img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/bltd92f9c2458b232ef/6649086b6d7055d1ed4d90d9/save-edits.png" alt="save-edits.png" height="auto" />
Conclusion
In this module, you've learned how to effectively edit taxonomies within Contentstack, enabling you to adapt your content organization structure to meet your requirements better. Should you have further questions or require assistance, don't hesitate to contact our support team.

Editing a Taxonomy

Editing a Taxonomy Walkthrough

Here's a step-by-step guide for adding a taxonomy to a content type in your Contentstack account:
1. Log in to Your Contentstack Account: &nbsp; &nbsp;Open your web browser and navigate to the Contentstack login page. Enter your credentials to log in to your account.
2. Access Content Models: &nbsp; &nbsp;Once logged in, you'll be directed to your dashboard. On the left navigation panel, click the "Content Models" icon. Then, either create a new content type or select an existing one where you want to add the taxonomy.
3. Open Content Type Builder: &nbsp; &nbsp;On the "Content Type Builder" page, you'll see the fields of your selected content type. To add a new field, click the "Insert a field" (+ icon) that appears when you hover the cursor.
4. Select Taxonomy Field: &nbsp; &nbsp;From the list of available fields, choose "Taxonomy." <img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/blt1955decba4e089d9/664909a4dda14b775adff5fb/add-taxonomy.png" alt="add-taxonomy.png" height="auto" />
5. Configure Taxonomy Field Properties: &nbsp; &nbsp;Click on the properties (cog icon) to configure the properties of the taxonomy field.
Note:&nbsp;that the default UID for the taxonomy field is set to "taxonomies" and cannot be updated.

<img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/bltb17fde85126bc9a8/664909d0dda14bd66fdff5ff/configure.png" alt="configure.png" height="auto" />
6. Add Taxonomy: &nbsp; &nbsp;Click the "+ Add Taxonomy" button. A dropdown menu will appear with available taxonomies within the stack. Select the taxonomy you want to add. Note: You can include multiple taxonomies within a single taxonomy field in a content type.

<img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/blt773afb5030bd9b0c/66490a045c2483cdbcbc3488/add-taxonomy2.png" alt="add-taxonomy2.png" height="auto" />
7. Set Maximum Number of Terms: &nbsp; &nbsp;You can limit the maximum number of terms for the taxonomy field by entering a number in the "Maximum Number of Terms" field.
Note&nbsp;that the maximum number of terms allowed per entry is 25.
8. Make Field Mandatory (Optional): &nbsp; &nbsp;If you want to make this taxonomy field mandatory, disable the "Optional Field" toggle.
9. Apply Changes: &nbsp; &nbsp; Once you've configured the taxonomy field according to your requirements, click "Apply" to add the taxonomy to the content type.
11. Start Categorizing Entries: &nbsp; &nbsp; With the taxonomy field added to your content type, you can begin adding entries and categorizing them using your selected taxonomy. 10. Confirmation: &nbsp; &nbsp; Upon successful addition, you'll receive a confirmation message. You can now see the taxonomy field included in your content type.<img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/bltb0f09f2ab2af37b2/66490a375fd9afddf270e288/confirm.png" alt="confirm.png" height="auto" />By following these steps, you can seamlessly integrate taxonomy into your content types and efficiently organize your content.

Add Taxonomy to a Content Type

Welcome to the module on Deleting a Taxonomy in Contentstack. In this module, we'll explore the process of removing a taxonomy from your stack.
Introduction
If you have any questions or need assistance, please contact our support team for more information.
Deleting a Taxonomy
Contentstack allows you to delete a taxonomy you've created within your stack. However, it's crucial to understand that unless you're the Owner or Admin of the stack, you cannot delete taxonomies created by other stakeholders.
Step-by-Step Guide
Let's walk through the steps to delete a taxonomy:
<ol>
 <li>
 
 Accessing Taxonomy Settings:
 <ul>
 <li>
 Log in to your Contentstack account and navigate to the stack where you want to delete a taxonomy.
 </li>
 <li>
 Click on the "Settings" icon (shortcut: press "S") located on the left navigation panel.
 </li>
 <li>
 Select "Taxonomy" from the settings options.
 </li>
 </ul>
 
 </li>
 <li>
 
 Selecting and Deleting the Taxonomy:
 <ul>
 <li>
 Identify the taxonomy you wish to delete from the list.
 </li>
 <li>
 Click on the "ellipsis" (three dots) icon in the Actions column next to the taxonomy you want to remove.
 </li>
 <li>
 From the dropdown menu, choose "Delete."
 </li>
 </ul>
 
 </li>
</ol><img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/blt3d7ef070c8554ae8/66490ab952619d0cc1a90a6c/delete.png" alt="delete.png" height="auto" />

<ol>
 <li>
 
 Confirming Deletion:
 <ul>
 <li>
 In the prompted Delete Taxonomy modal, type "DELETE" to confirm your action.
 </li>
 <li>
 Click on the "Delete" button to finalize the deletion process.
 </li>
 </ul>
 
 </li>
</ol><img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/blt8e1438a4941b4fbc/66490ae70b508aca6cdcfc91/delete-confirm.png" alt="delete-confirm.png" height="auto" /> Warning
It's important to understand the consequences of deleting a taxonomy:
<ul>
 <li>
 Permanent deletion of the taxonomy and removal of its association with added content types.
 </li>
 <li>
 Deletion of all terms within the taxonomy and removal from entries.
 </li>
</ul>
Additional Deletion Option
Alternatively, you can also delete a taxonomy by following these steps:
<ul>
 <li>
 Click on the "ellipsis" (three dots) at the top right corner of the taxonomy page.
 </li>
 <li>
 Select "Delete Taxonomy."
 </li>
</ul>
<img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/blta3dc2fcc177f1e2f/66490b55428432fa191989cc/delete-confirm.png" alt="delete-confirm.png" height="auto" /> Conclusion
In conclusion, deleting a taxonomy in Contentstack involves a straightforward process, but it's essential to proceed with caution due to the permanent nature of this action. Understanding the implications of deletion ensures smooth management of your content structure.

Deleting a Taxonomy

With Contentstack, you can easily export a taxonomy in a JSON or CSV file.
To export a taxonomy, log in to your&nbsp;<a href="https://www.contentstack.com/login">Contentstack account</a>&nbsp;and perform the following steps:
<ol>
 <li>
 Go to your&nbsp;<a href="https://www.contentstack.com/docs/developers/set-up-stack/about-stack">stack</a>&nbsp;where you want to export a taxonomy, navigate to the “Settings” icon (press “S”) on the left navigation panel, and select&nbsp;Taxonomy.
 </li>
 <li>
 Select the taxonomy you want to export and click the “ellipsis” (three dots) in the&nbsp;Actions&nbsp;column.
 </li>
 <li>
 Choose the file format for exporting your taxonomy by selecting either&nbsp;Export as JSON&nbsp;or&nbsp;CSV.
 </li>
</ol>
<img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/bltdd5f3916194f4ddc/66490bbadda14b0548dff606/export.png" alt="export.png" height="auto" />This will download your taxonomy's JSON or CSV file and save it to your local storage system.

Exporting a Taxonomy

Import a Taxonomy

Terms serve as the primary classification elements within a taxonomy, allowing you to establish hierarchical structures and incorporate them into entries.
Example -&nbsp;In the Superhero taxonomy, we have two child terms: Origin &amp; Powers and Abilities.&nbsp; Each of these terms has two child terms.&nbsp;
Another Example -&nbsp;In a taxonomy related to "Animals," terms could include "Mammals," "Birds," "Reptiles," etc. Each of these terms represents a distinct category within the taxonomy.
Terms are used to classify and tag entry items. When creating or editing entries, users can select terms from predefined taxonomies to indicate the subject, topic, or category that the entry belongs to. This helps organize and structure entries, making searching, filtering, and managing easier.

<h1>Creating&nbsp;a Term</h1>
To&nbsp;create a term&nbsp;in Contentstack, follow these steps -
<ol>
 <li>
 
 Login to Contentstack: Go to the Contentstack&nbsp;<a href="https://www.contentstack.com/login">login page</a>&nbsp;and enter your credentials to log in to your account.
 
 </li>
 <li>
 
 Access Taxonomies: Navigate to the "Settings" icon once logged in. Under "Settings," you'll find an option for "Taxonomies." Click on it to access the Taxonomies section.
 
 </li>
 <li>
 
 Select&nbsp;a Taxonomy: In the Taxonomies section, you'll see a list of existing taxonomies, if any. Choose the taxonomy where you want to create the term.&nbsp;
 
 </li>
 <li>
 
 Add Term: After selecting the appropriate taxonomy, you'll see a button&nbsp;to "+ New Term."&nbsp;Click on it to create a new term within the selected taxonomy. We are creating a new term under the "Genre" taxonomy here.
 
 </li>
</ol><img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/blt3e1bff326b9b32eb/66490fb052619df401a90a72/new-term.png" alt="new-term.png" height="auto" />
Enter Term Details: In the "Term Details" page, you can enter details for the new term. This typically includes:
- Term Name: Enter the name of the term. For Example -&nbsp;Fiction
- Term UID: The Unique ID is automatically populated, which you can edit.
<img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/blt68fc44593ccfb6d2/66490fdab2e852b513451914/term-details.png" alt="term-details.png" height="auto" /> Save Term: Once you've entered the required details for the term, click on the "Save"&nbsp;button to create the term.

<img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/bltf928dc426249a726/66490ffe16e6bf4dff590ca0/save-term.png" alt="save-term.png" height="auto" /> After saving the term, you should see a confirmation message indicating that the term has been successfully created. The following shows the term "Fiction" created under the "Genre"&nbsp;taxonomy.

<img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/bltbf49c5b76f147235/66491058acadaf2407728327/genre.png" alt="genre.png" height="auto" /> Now, if you want to create a sibling term (a term at the same level as the current term) or a child term (a term nested within the current term), you can select any one from the button dropdown as shown below.

<img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/blt419dc0a78431e93d/664910800b508ae4bedcfc97/sibling.png" alt="sibling.png" height="auto" />
 To Create a Sibling Term -
<ol>
 <li>
 Select the&nbsp;option to "Create a Sibling Term" from the dropdown. The selected option is always "Create a Sibling Term"&nbsp;by default. Click on the button&nbsp;"Create a Sibling Term". Here, we are creating a sibling term for the term "Fiction."
 </li>
</ol><img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/blt5bce5b24075215db/664910b13092d0fa8b63f9dc/create-sib.png" alt="create-sib.png" height="auto" />This takes you to the "Term Details" page. Enter the Term Name and Term UID. Here, we are creating&nbsp;a new sibling term,&nbsp;"Non-Fiction." <img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/blt0f2a0ccb99ee1bbf/66491102efc97a0b144c0a81/non-fiction.png" alt="non-fiction.png" height="auto" />Click on the "Save" button to create the term successfully.&nbsp;The following shows the term&nbsp;"Non-Fiction"&nbsp;being created under the "Genre"&nbsp;taxonomy.

<img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/bltc88b4a3bac5dfb41/6649113f4bfb713cf742c101/non-fiction2.png" width="auto" alt="non-fiction2.png" height="auto" max-width="auto" style="max-width: auto;width: auto;height: auto;" /> You can also create a sibling term by clicking the following icon and the above steps.
<img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/blt8ecc56c1036ca4a7/664911705fd9af38df70e290/add-sibling.png" width="698" alt="add-sibling.png" height="auto" max-width="698" style="max-width: 698px;width: 698;height: auto;" />
To Create a Child Term -
<ol>
 <li>
 Select the&nbsp;option to "Create a Child Term" from the dropdown. Click on the button&nbsp;"Create a Child Term". Here, we are creating a child term for the term "Fiction."
 </li>
</ol>
<img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/blt5bcd18629f02d153/664911ae342fb50f7a62cc5c/create-child.png" width="698" alt="create-child.png" height="auto" max-width="698" style="max-width: 698px;width: 698;height: auto;" /> This takes you to the "Term Details" page. Enter the Term Name and Term UID and click the "Save" button.&nbsp;Here, we are creating&nbsp;a new child term,&nbsp;"Historical Fiction."&nbsp;The following shows the term&nbsp;" Historical Fiction"&nbsp;being created under the "Genre"&nbsp;taxonomy.
<img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/bltae145a26adaf6260/664911ec3092d022d263f9e0/term-details2.png" alt="term-details2.png" height="auto" /> You can also create a child term by clicking the following icon and the above steps.
<img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/bltf305bc137e7448fb/664912210b508a12abdcfc9f/add-child-btn.png" width="695" alt="add-child-btn.png" height="auto" max-width="695" style="max-width: 695px;width: 695;height: auto;" /> By following these steps, you can effectively create&nbsp;terms within your Contentstack account, facilitating better organization and classification of your entry items.

Creating Terms

Once you've created terms, you retain the flexibility to adjust terms, empowering you to make changes like updating their names as needed. To&nbsp;edit a&nbsp;term&nbsp;in Contentstack, follow these steps -
<ol>
 <li>
 
 Login to Contentstack: Go to the Contentstack&nbsp;<a href="https://www.contentstack.com/login">login page</a>&nbsp;and enter your credentials to log in to your account.
 
 </li>
 <li>
 
 Access Taxonomies: Navigate to the "Settings" icon once logged in. Under "Settings," you'll find an option for "Taxonomies." Click on it to access the Taxonomies section&nbsp;to access the list of taxonomies in your Contentstack organization.
 
 </li>
 <li>
 
 Choose Taxonomy: From the list of available taxonomies, select the taxonomy containing the term you want to edit. Here, we select the taxonomy&nbsp;"Genre."
 
 </li>
 <li>
 
 Locate Term: Find the term you wish to edit within the selected taxonomy. You may need to expand categories or scroll through the list to locate the specific term and click on the term you need to edit.&nbsp;Here, we will edit the term&nbsp;"Historical Fiction,"&nbsp;under the term&nbsp;"Fiction."
 
 </li>
</ol>
<img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/blte0a2e094e2870f56/664913ed4b531e6623c327f9/edit-term1.png" alt="edit-term1.png" height="auto" />
Edit Term: When you click on the term you want to edit, it opens the "Term Details" page, where you can update the term's name. Here, we will update the name of the term&nbsp;"Historical Fiction."
<img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/bltfb2b2d57857bbb19/6649140fd4d02e180b2eac07/edit-term2.png" alt="edit-term2.png" height="auto" />
We will update the name of the term&nbsp;"Historical Fiction"&nbsp;to&nbsp;"Historical/Old Fiction."&nbsp;Click the "Update" button to update the term successfully.

<img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/bltf83833ed72fc6e7c/6649143916e6bf5faf590ca4/edit-term3.png" width="auto" alt="edit-term3.png" height="auto" max-width="auto" style="max-width: auto;width: auto;height: auto;" />
The following shows the updated name for the term&nbsp;"Historical/Old Fiction"&nbsp;being created.

<img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/bltf2fdd3d5eefde954/664914e452619d964ba90a76/hiatorical.png" alt="hiatorical.png" height="auto" />

Editing Terms

Within your stack, you can delete terms from a taxonomy.&nbsp;To&nbsp;delete a term&nbsp;in Contentstack, follow these steps -
<ol>
 <li>
 
 Login to Contentstack: Go to the Contentstack&nbsp;<a href="https://www.contentstack.com/login">login page</a>&nbsp;and enter your credentials to log in to your account.
 
 </li>
 <li>
 
 Access Taxonomies: Navigate to the "Settings" icon once logged in. Under "Settings," you'll find an option for "Taxonomies." Click on it to access the Taxonomies section&nbsp;to access the list of taxonomies in your Contentstack organization.
 
 </li>
 <li>
 
 Choose Taxonomy: From the list of available taxonomies, select the taxonomy containing the term you want to delete. Here, we select the taxonomy&nbsp;"Genre."
 
 </li>
 <li>
 
 Choose Term: Select the term you want to delete from the list of available terms.
 
 </li>
</ol>
<img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/bltd6b3065ffc2be7b9/664918433092d04da863f9e5/delete1.png" alt="delete1.png" height="auto" />Delete Term: Click on the ellipsis(three dots) icon on the top right corner of the page, which opens a dropdown list from which click the&nbsp;"Delete Term"&nbsp;option.


<img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/blt53ad850417bf1712/664918684bfb71e49b42c106/delete5.png" width="auto" alt="delete5.png" height="auto" max-width="auto" style="max-width: auto;width: auto;height: auto;" />
 Click on Delete: Clicking on the "Delete Term" option opens a dialog box that asks you to confirm the delete operation. Deleting a parent term will also automatically delete its child term(s). Here, it shows that we will delete the term "Fiction," which contains the child term "Historical/Old Fiction," which will also be&nbsp;deleted. <img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/blte16e4232a1532d3c/664918685fd9afd68670e295/delete3.png" width="auto" alt="delete3.png" height="auto" max-width="auto" style="max-width: auto;width: auto;height: auto;" /> After successful deletion, you can see that the "Fiction" term is deleted along with its child term, "Historical/Old Fiction." <img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/blt1b8e0895d4479e66/66491868a3f9df6ea1c10bba/delet2.png" alt="delet2.png" height="auto" />Following these steps, you can effectively delete terms within your Contentstack account, facilitating better organization and classification of your entry items.

Deleting Terms

Let's&nbsp;consider an example. Our stack has the following taxonomy created.We have terms inside&nbsp;Superhero, as seen in the image below.<img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/blta2c07a004b22deaf/66491a5c52619de069a90a7a/cm1.png" alt="cm1.png" height="auto"/><h2>Get all&nbsp;taxonomies</h2>The Get All Taxonomies request provides detailed information about every taxonomy available within your company's specific stack.Example:&nbsp;Let's retrieve every taxonomy found within our stack.&nbsp;Take into consideration the example given in the Overview section.Below is the curl command for the same.&nbsp;<pre>curl --location 'https://api.contentstack.io/v3/taxonomies' \ --header 'api_key: **************' \ --header 'authorization: *******************' \ --header 'Content-Type: application/json' \ &nbsp;--data ''</pre>View the screenshot below to view the outcome of the postman call.<img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/blte56d3a57b7d08f32/66491abb5c2483ea33bc3490/cm2.png" alt="cm2.png" height="auto"/><h2>Get a single taxonomy</h2>The "Get a single taxonomy" request provides detailed information about a single taxonomy in a given stack.Example: Consider the example given in the Overview section for this.&nbsp;Let's fetch&nbsp;superhero&nbsp;taxonomy.Below is the curl command to fetch&nbsp;superhero&nbsp;taxonomy<pre>curl --location 'https://api.contentstack.io/v3/taxonomies/superhero' \ --header 'api_key: **************' \ --header 'authorization: ****************' \ --header 'Content-Type: application/json' \ --data ''</pre>View the screenshot below to see the outcome of the postman call.<img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/blt7a5e0ccf8f22c799/66491af40bbc62953a7fabeb/cm3.png" alt="cm3.png" height="auto"/><h2>Get a single term</h2>The "Get a single term" request provides detailed information about a single term in a given taxonomy.<pre>Example:&nbsp;Consider the following example, which is provided in the Overview section. Obtain a single term from the superhero taxonomy that refers to powers and abilities.</pre><pre>curl --location 'https://api.contentstack.io/v3/taxonomies/superhero/terms/powers_and_abilities' \ --header 'api_key: ***************' \ --header 'authorization: **********************' \ --header 'Content-Type: application/json' \ --data ''</pre>View the screenshot below to see the outcome of the postman call.<img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/blt76708a5e5731c2a7/66491b500a0de6460e314d1e/cm4.png" alt="cm4.png" height="auto"/><h2>Create a term</h2>Within your stack, a term in a specific taxonomy is created via the Create a Term request.Since terms are organized hierarchically in a taxonomy, it's important to define the order when creating new terms. For instance, when creating a term at the root level, set the&nbsp;parent_uid&nbsp;as&nbsp;null&nbsp;and specify the level as 1 or above to position it in the list. To create a child term, provide the&nbsp;parent_uid&nbsp;of the parent term where you want to add the new child term and indicate the desired position within the order parameter.<h2>Creating a Term&nbsp; at the Root level</h2>When creating terms at the parent level, the request body should look like this:Example:&nbsp;We would like to&nbsp; make a new Term at the root level.&nbsp; For this, consider the example provided in the previous modules. And add the term "Films" to the "Superhero"&nbsp;taxonomy.&nbsp; Notice that the parent UID is&nbsp;null.Below is the curl command to create a term.&nbsp;<pre>curl --location 'https://api.contentstack.io/v3/taxonomies/superhero/terms' \ --header 'api_key:**************' \ --header 'authorization: ********************' \ --header 'Content-Type: application/json' \ --data '{ &nbsp; "term": { &nbsp; &nbsp; "uid": "films", &nbsp; &nbsp; "name": "Films", &nbsp; &nbsp; "parent_uid": null &nbsp; } }'</pre>View the screenshot below to see the outcome of the postman call.<img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/blte499ee888d5dbecf/66491b9b342fb5f06e62cc64/cm5.png" alt="cm5.png" height="auto"/>The result should be a new Term 'Films' located in the Superhero Taxonomy at the root level. <img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/bltad086fe9c6e5a3d6/66491bc34ac76eba9f40f88c/cm6.png" alt="cm6.png" height="auto"/><h2>Creating a Term under a parent Term</h2>When creating terms at the child level, the request body should look like this:<pre>curl --location 'https://api.contentstack.io/v3/taxonomies/superhero/terms' \ --header 'api_key:**************' \ --header 'authorization: ********************' \ --header 'Content-Type: application/json' \ --data '{ &nbsp; "term": { &nbsp; &nbsp; "uid": "scientific_experimentation", &nbsp; &nbsp; "name": "Scientific Experimentation", &nbsp; &nbsp; "parent_uid": "origin" &nbsp; } }'</pre><img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/bltb7de7c5f1d2ec22f/66491cd2a3f9dfedffc10bc2/cm7.png" alt="cm7.png" height="auto"/> The result should be a new Term located under the Origin parent term:<img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/blt160628212409b4a6/66491d1cf445aa8b7254c5c4/cm8.png" alt="cm8.png" height="auto"/>

Content Management APIs for Taxonomy

Using the Content Management API to Read the Taxonomy Information

Creating a New Taxonomy with the Content Management API

Querying using the Taxonomy IN Operator

Querying with the Taxonomy Equals or Below Operator

Use case
Breadcrumbs serve as a helpful navigation tool, enabling users to easily trace their path and understand their position within the hierarchical structure of a website, particularly useful for blogs and product listings.
Solutions
<ul>
 <li>
 The taxonomy terms hierarchy can be used to generate Breadcrumbs for Blog articles or product entries.
 </li>
 <li>
 Define the taxonomy terms in the hierarchy for product entries&nbsp;
 </li>
</ul>
<img src="https://images.contentstack.io/v3/assets/bltebc53cfaf0dd6403/blt11ace396066f4b52/664924aaf445aaa5cb54c5f8/breadcrumbs.png" alt="breadcrumbs.png" height="auto" />
 
<ul>
 <li>
 Use this taxonomy&nbsp;hierarchy to generate breadcrumbs by using terms associated and its hierarchy and category-specific pages can be generated by making&nbsp;entries based on&nbsp;taxonomy&nbsp;Content delivery Api call&nbsp;in frontend.
 </li>
 <li>
 Also, Dynamic URLs generation for an entry based on the taxonomy hierarchy eg. e-commerce product pages are also can be done to match URL hierarchy with breadcrumbs&nbsp;
 </li>
</ul>

<h1>Advanced Search filter for Content</h1>
Use case:
We need a Blog listing page with sidebar filter for blog categories
Solution:
<ul>
 <li>
 Define a taxonomy structure and add&nbsp;nested terms for each blog category
 </li>
 <li>
 Each blog article will be tagged with the blog category term
 </li>
 <li>
 On the website we will list all blog categories with hierarchy in the sidebar and filter based on the selected combination of categories.&nbsp; The developer can make CDA API calls for blog articles filtered based on taxonomy terms. See the&nbsp;<a href="https://www.contentstack.com/docs/developers/apis/content-delivery-api#taxonomy">API guide</a>&nbsp;for more details.
 </li>
</ul>

<h1> Multi-Brand within Single stack architecture</h1>
<h3>Use case</h3>
Customer has&nbsp;one Stack and would like to accommodate multiple brand website which will have some global&nbsp;content&nbsp;
<ul>
 <li>
 
 Brand 1 Domain (https://www.brand1.com/)
 
 </li>
 <li>
 
 Brand 2&nbsp;Domain (https://www.brand2.com/)
 
 </li>
 <li>
 
 They need brand specific entries access control for brand specific custom roles&nbsp;
 
 </li>
 <li>
 
 CDA APIs to fetch brand specific content entries for each domain.
 
 </li>
</ul>
<h3>Solution Overview:</h3>
<ul>
 <li>
 
 Create a new Taxonomy to define brands
 
 </li>
 <li>
 
 In the Content Model we will add a Taxonomy field Selector for Brand&nbsp;in&nbsp;content types (Page, blog, product etc)
 
 </li>
 <li>
 
 Create an asset folder for each brand to store separate brand specific&nbsp;assets and set up asset permission in brand specific custom roles
 
 </li>
 <li>
 
 Setup custom Roles for each Brand&nbsp;Content editors with proper accessibility as per taxonomy access (upcoming enhancement in roles) and brand based asset folder access
 
 </li>
 <li>
 
 The editor will publish changes to the production&nbsp;Environment with the Taxonomy
 
 </li>
 <li>
 
 On each brand specific frontend site, the developer will make API calls with filtering content based on brand taxonomy to get pages specific to brand taxonomy&nbsp;
 
 </li>
</ul>

Use Cases for Taxonomy

This course is intended to outline the Contentstack features and techniques for using the Taxonomy features with&nbsp;your content, understand the APIs, and how to leverage Taxonomy within your implementation.&nbsp; Completion of this course earns a 'badge' for this topic.!Required for this course:<ol><li>Account in Contentstack with access to a Stack as an Administrator or Developer. Create a training Stack&nbsp;<a href="https://www.contentstack.com/academy-old" target="_self">here</a>. Training stacks are available for 90 days. Alternatively, you can bootstrap a&nbsp;<a href="https://www.contentstack.com/docs/developers/cli/bootstrap-starter-apps">Starter App via the CLI</a>&nbsp;or from the&nbsp;<a href="https://app.contentstack.com/#!/marketplace/starters">Marketplace</a>.&nbsp;</li><li>Permissions to create a new Taxonomy and edit Content Types in a Stack.&nbsp;</li></ol>

Taxonomy Foundations Thumbnail

Taxonomy Foundations

Installing AI Assistant

Using AI Assistant

Creating Custom Actions

Using Custom Actions

<h2>AI Assistant </h2>&nbsp;Unlock the full potential of your content creation with AI Assistant. Designed for beginners and seasoned users alike, this comprehensive guide takes you through the seamless installation and advanced usage of AI Assistant within the Contentstack platform. Discover how integrating powerful large language models can streamline your workflow, enhance writing efficiency, and ensure your content stands out.From the initial installation through the Marketplace to leveraging AI Assistant for optimizing and generating compelling content, this course covers it all. You’ll learn how to update titles for SEO, create summaries, generate tags, and even customize actions to suit your specific needs. With step-by-step instructions and practical examples, you'll see how easy it is to elevate your content quality and maintain GDPR compliance effortlessly. Join us and transform the way you manage and produce content with AI-driven precision.

Learn the foundations of using AI Assistant in Contentstack.

AI Assistant Foundations

AI icons.zip

AI Assistant Foundations Thumbnail

Introduction to our AI Foundations course.

AI Foundations Introduction

AI Foundations

What is Artificial Intelligence?

Machine Learning

Machine Learning Frameworks

Deep Learning

Generative AI

Prompting Generative AI

Custom GPTs & RAG

Hallucinations

Bias in AI

Ethical Considerations

Conclusion

This course offers an in-depth introduction to artificial intelligence (AI), examining its evolution, applications, and ethical implications. Beginning with a historical perspective, it traces AI's development from early experiments to today's advanced technologies like ChatGPT and Google Gemini. The curriculum delves into key AI concepts and terminologies such as machine learning, deep learning, and neural networks, with practical examples that illustrate their use in real-world applications. Students will explore both the capabilities and limitations of current AI tools, learning how to apply AI in various contexts, from business operations to creative projects. Additionally, the course addresses the societal impacts of AI, discussing issues like bias, privacy, and the ethical use of AI technologies. This comprehensive overview aims to equip learners with a foundational understanding of AI to navigate and leverage this transformative technology effectively.

This course provides a comprehensive overview of artificial intelligence (AI), covering its history, key concepts like machine learning and deep learning, and current applications such as ChatGPT and Google Gemini. It explores the practical uses and limitations of AI tools, and discusses ethical considerations like bias and privacy. The aim is to equip learners with a foundational understanding to effectively apply AI in various fields.

AI Foundations Thumbnail

Welcome to the Contentstack Academy - where you can learn all things Contentstack. We offer short-form content and longer formal courses. Whatever your learning style, we have material here for you to get the most out of Contentstack.

Academy-demo