Contentstack Action
The Contentstack action connector lets you perform specific actions within your stack. With this connector you can create entries, set up workflow stages, and localize entries.
Set up Contentstack
The Contentstack action connector lets you perform the following actions:
- Publish Queue
- 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
Let’s look at each of them in detail.
Publish Queue
This action fetches all the entries present in the Publish Queue in Contentstack.
- Click Configure Action Step from the left navigation panel.
- Click Action Step to configure third-party services.
- Within the Configure Action Step, click the Contentstack connector.
- Under Choose an Action tab, select the Publish Queue action.
- In the Configure Action tab, click + Add New Account to add your Contentstack account.
- In the pop-up window, provide OAuth permissions for all the values by checking the boxes and click Authorize.
Note: Contentstack offers support for Branches in Automation Hub. You must authenticate and re-authorize your existing account by checking all the permissions to add your Contentstack account.
- In the pop-up that appears, view the module-specific access rights provided to the app. Click Authorize to complete authorization.
- Provide an Account Name and click Save.
- Select a Stack and Branch from the lookup list.
Note: By default, the main branch is selected (even if the Branch field is empty).
- [Optional] Enable the Show optional fields toggle button to display the Customized Data (query), Entry Limit, and Skip (Pagination) fields. You can also include the count for the total number of entries by clicking the checkbox.
- Provide your data in the Customized Data (query) field to filter the entry. Enter your data in a key-value pair in JSON format.
Additional Resource: Refer to the Content Delivery API documentation to know more about queries.
- Once done, click Proceed.
- Click Test Action to test the configured action.
- The output will be shown as follows. Click the Save and Exit button.
Get All Content Types
This action fetches all the content types present in a stack.
- Under Choose an Action tab, select the Get All Content Types action.
- In the Configure Action tab, click + Add New Account to add your Contentstack account.
- In the pop-up window, provide OAuth permissions for all the values by checking the boxes and click Authorize.
Note: Contentstack offers support for branches in Automation Hub. You must authenticate and re-authorize your existing account by checking all the permissions to add your Contentstack account.
- In the pop-up that appears, view the module-specific access rights provided to the app. Click Authorize to complete authorization.
- Provide an Account Name and click Save.
- Select a Stack, and Branch from the Lookup list. You can also include the total count of the content types and the branch details by clicking the respective checkboxes.
Note: By default, the main branch is selected (even if the Branch field is empty).
- [Optional] Enable the Show optional fields toggle button to display the Content Type Limit, Customized Data (query), and Skip Content Type (Pagination) fields. Click the checkbox to include the global field schema details.
- Provide your data in the Customized Data (query) field to filter the retrieval of content types. Enter your data in the Key, and Value fields.
Additional Resource: Refer to the Content Delivery API Docs for more information on Queries.
Note: The Customized Data (query) field acts as a filter to fetch the content types that fulfill the specifications provided in the Key-Value fields.
- Once done, click Proceed.
- Click Test Action to test the configured action.
- The output will be shown as follows. Click the Save and Exit button.
Get All Entries
This action fetches all the entries present in a stack.
- Under Choose an Action tab, select the Get All Entries action.
- In the Configure Action tab, click + Add New Account to add your Contentstack account.
- In the pop-up window, provide OAuth permissions for all the values by checking the boxes and click Authorize.
Note: Contentstack offers support for branches in Automation Hub. You must authenticate and re-authorize your existing account by checking all the permissions to add your Contentstack account.
- In the pop-up that appears, view the module-specific access rights provided to the app. Click Authorize to complete authorization.
- Provide an Account Name and click Save.
- Select a Stack, Branch, and Content Type from the Lookup list.
You can fetch the UID for all the previously configured automation steps directly from the Lookup list as shown below:Note: By default, the main branch is selected (even if the Branch field is empty).
- [Optional] Enable the Show optional fields toggle button to display the Entry Limit, Skip Entry (Pagination), Entry Version, and Select Locale fields.
- Provide your data in the Customized Data (query) field to filter the entry. Enter your data in the Key, Operator, and Value fields.
In the Customized Data (query) field, you can filter the entry based on Updated At/Created At options. For example, you can fetch all the entries updated after a certain time and date as shown below:You can view the Lookup data for all the fields present in the content type including Reference, Modular Blocks and Group fields. Using the Operator filter you can sort the data.
Additional Resource: Refer to the Content Delivery API Docs for more information on Queries.
In the Reference field, enter the ID of the reference field of your content type.
You can also include the count of the entries, metadata details, workflow, branch and publish details by clicking the respective checkboxes.
Note: The Reference and the Customized Data (query) fields act as filters to fetch only those entries that fulfill the specifications provided in both the fields.
- Once done, click Proceed.
- Click Test Action to test the configured action.
- The output will be shown as follows. Click the Save and Exit button.
Delete an Entry
This action deletes an entry in a stack.
- Under Choose an Action tab, select the Delete an Entry action.
- In the Configure Action tab, click + Add New Account to add your Contentstack account.
- In the pop-up window, provide OAuth permissions for all the values by checking the boxes and click Authorize.
Note: Contentstack offers support for branches in Automation Hub. You must authenticate and re-authorize your existing account by checking all the permissions to add your Contentstack account.
- In the pop-up that appears, view the module-specific access rights provided to the app. Click Authorize to complete authorization.
- Provide an Account Name and click Save.
- Select a Stack, Branch, Content Type, and Entry from the Lookup list.
Note: By default, the main branch is selected (even if the Branch field is empty).
- [Optional] Enable the Show optional fields toggle button to display the Locale field. Click the Delete all the localized entries checkbox to delete all the localized versions of the entry.
Note: If you provide the locale and click the Delete all the localized entries checkbox, all the localized entries will be deleted along with the fallback language i.e., English-United States (M) and the value passed in the locale field will become null.
Note: If you select the fallback language in the locale field, i.e., English-United States (M), and uncheck the checkbox, the entry in the fallback language will be deleted and localized entries will be preserved.
- Once done, click Proceed.
- Click Test Action to test the configured action.
- The output will be shown as follows. Click the Save and Exit button.
Add Items to a Release
This action lets you add multiple items to a release.
- Under Choose an Action tab, select the Add Items to a Release action.
- In the Configure Action tab, click + Add New Account to add your Contentstack account.
- In the pop-up window, provide OAuth permissions for all the values by checking the boxes and click Authorize.
Note: Contentstack offers support for branches in Automation Hub. You must authenticate and re-authorize your existing account by checking all the permissions to add your Contentstack account.
- In the pop-up that appears, view the module-specific access rights provided to the app. Click Authorize to complete authorization.
- Provide an Account Name and click Save.
- Select a Stack, Branch, and Release from the Lookup list. Provide your item data in the Release Item Data field.
Note: Provide your entry data as per the schema in JSON format only. Both entries and assets can be added to the release. In case of assets, the value for the content_type_uid key should be built_io_upload.
Note: By default, the main branch is selected (even if the Branch field is empty).
- [Optional] Enable the Show optional fields toggle button to display the branch details by clicking the Include branch checkbox.
- Once done, click Proceed.
- Click Test Action to test the configured action.
- The output will be shown as follows. Click the Save and Exit button.
Clone a Release
This action lets you create a copy of a release.
- Under Choose an Action tab, select the Clone a Release action.
- In the Configure Action tab, click + Add New Account to add your Contentstack account.
- In the pop-up window, provide OAuth permissions for all the values by checking the boxes and click Authorize.
Note: Contentstack offers support for branches in Automation Hub. You must authenticate and re-authorize your existing account by checking all the permissions to add your Contentstack account.
- In the pop-up that appears, view the module-specific access rights provided to the app. Click Authorize to complete authorization.
- Provide an Account Name and click Save.
- Select a Stack, Branch, and Release from the Lookup list.
Note: By default, the main branch is selected (even if the Branch field is empty).
- Provide a Release Name and a Release Description for the release to be created.
- [Optional] Enable the Show optional fields toggle button to display the branch details by clicking the Include branch checkbox.
- Once done, click Proceed.
- Click Test Action to test the configured action.
- The output will be shown as follows. Click the Save and Exit button.
Create a Release
This action lets you create a release.
- Under Choose an Action tab, select the Create a Release action.
- In the Configure Action tab, click + Add New Account to add your Contentstack account.
- In the pop-up window, provide OAuth permissions for all the values by checking the boxes and click Authorize.
Note: Contentstack offers support for branches in Automation Hub. You must authenticate and re-authorize your existing account by checking all the permissions to add your Contentstack account.
- In the pop-up that appears, view the module-specific access rights provided to the app. Click Authorize to complete authorization.
- Provide an Account Name and click Save.
- Select a Stack, Release Name, Release Description, and Branch from the Lookup list.
Note: By default, the main branch is selected (even if the Branch field is empty).
- [Optional] Enable the Show optional fields toggle button to display the branch details by clicking the Include branch checkbox.
- Once done, click Proceed.
- Click Test Action to test the configured action.
- The output will be shown as follows. Click the Save and Exit button.
Delete Items from a Release
This action lets you delete multiple items from a release.
- Under Choose an Action tab, select the Delete Items from a Release action.
- In the Configure Action tab, click + Add New Account to add your Contentstack account.
- In the pop-up window, provide OAuth permissions for all the values by checking the boxes and click Authorize.
Note: Contentstack offers support for branches in Automation Hub. You must authenticate and re-authorize your existing account by checking all the permissions to add your Contentstack account.
- In the pop-up that appears, view the module-specific access rights provided to the app. Click Authorize to complete authorization.
- Provide an Account Name and click Save.
- Select a Stack, Branch, and Release from the Lookup list. Provide your item data in the Release Item Data field.
Note: Provide your entry data as per the schema in JSON format only.
Note: By default, the main branch is selected (even if the Branch field is empty).
- [Optional] Enable the Show optional fields toggle button to display the branch details by clicking the Include branch checkbox.
- Once done, click Proceed.
- Click Test Action to test the configured action.
- The output will be shown as follows. Click the Save and Exit button.
Deploy a Release
This action lets you deploy a release to an environment.
- Under Choose an Action tab, select the Deploy a Release action.
- In the Configure Action tab, click + Add New Account to add your Contentstack account.
In the pop-up window, provide OAuth permissions for all the values by checking the boxes and click
Authorize.Note: Contentstack offers support for branches in Automation Hub. You must authenticate and re-authorize your existing account by checking all the permissions to add your Contentstack account.
- In the pop-up that appears, view the module-specific access rights provided to the app. Click Authorize to complete authorization.
- Provide an Account Name and click Save.
- Select a Stack, Branch, and Release from the Lookup list.
Note: By default, the main branch is selected (even if the Branch field is empty).
- Select an Environment, and Locale to deploy the release from the Lookup list.
- [Optional] Enable the Show optional fields toggle button to display the Publish Schedule field to schedule the deployment of the release.
Note: The release will be published immediately if the Publish Schedule field is empty.
- Once done, click Proceed.
- Click Test Action to test the configured action.
- The output will be shown as follows. Click the Save and Exit button.
Get All Items in a Release
This action fetches all the items present in a release.
- Under Choose an Action tab, select the Get All Items in a Release action.
- In the Configure Action tab, click + Add New Account to add your Contentstack account.
In the pop-up window, provide OAuth permissions for all the values by checking the boxes and click
Authorize.Note: Contentstack offers support for branches in Automation Hub. You must authenticate and re-authorize your existing account by checking all the permissions to add your Contentstack account.
- In the pop-up that appears, view the module-specific access rights provided to the app. Click Authorize to complete authorization.
- Provide an Account Name and click Save.
- Select a Stack, Branch, and Release from the Lookup list.
Note: By default, the main branch is selected (even if the Branch field is empty).
- [Optional]Enable the Show optional fields toggle button to display the Locale. You can also include the branch details by clicking the Include branch checkbox.
- Once done, click Proceed.
- Click Test Action to test the configured action.
- The output will be shown as follows. Click the Save and Exit button.
Get All Releases
This action fetches all the releases present in a stack.
- Under Choose an Action tab, select the Get All Releases action.
- In the Configure Action tab, click + Add New Account to add your Contentstack account.
In the pop-up window, provide OAuth permissions for all the values by checking the boxes and click
Authorize.Note: Contentstack offers support for branches in Automation Hub. You must authenticate and re-authorize your existing account by checking all the permissions to add your Contentstack account.
- In the pop-up that appears, view the module-specific access rights provided to the app. Click Authorize to complete authorization.
- Provide an Account Name and click Save.
- Select a Stack, and Branch from the Lookup list. Click the checkboxes for Include Count and Include count of release items to fetch the release details.
Note: By default, the main branch is selected (even if the Branch field is empty).
- [Optional]Enable the Show optional fields toggle button to display the Limit Release, and Skip Release fields. You can also include the branch details by clicking the Include branch checkbox.
- Once done, click Proceed.
- Click Test Action to test the configured action.
- The output will be shown as follows. Click the Save and Exit button.
Get Single Release
This action fetches the details of a single release.
- Under Choose an Action tab, select the Get Single Release action.
- In the Configure Action tab, click + Add New Account to add your Contentstack account.
In the pop-up window, provide OAuth permissions for all the values by checking the boxes and click
Authorize.Note: Contentstack offers support for branches in Automation Hub. You must authenticate and re-authorize your existing account by checking all the permissions to add your Contentstack account.
- In the pop-up that appears, view the module-specific access rights provided to the app. Click Authorize to complete authorization.
- Provide an Account Name and click Save.
- Select a Stack, Branch, and Release from the Lookup list.
Note: By default, the main branch is selected (even if the Branch field is empty).
- [Optional]Enable the Show optional fields toggle button to display the branch details by clicking the Include branch checkbox.
- Once done, click Proceed.
- Click Test Action to test the configured action.
- The output will be shown as follows. Click the Save and Exit button.
Get User Information
This action gets a user's first name, last name and email address based on the user ID.
- Under Choose an Action tab, select the Get User Information action.
- In the Configure Action tab, click + Add New Account to add your Contentstack account.
In the pop-up window, provide OAuth permissions for all the values by checking the boxes and click
Authorize.Note: Contentstack offers support for branches in Automation Hub. You must authenticate and re-authorize your existing account by checking all the permissions to add your Contentstack account.
- In the pop-up that appears, view the module-specific access rights provided to the app. Click Authorize to complete authorization.
- Provide an Account Name and click Save.
- Provide a User ID to fetch the user details.
Note: To fetch the user ID, you need to configure an action, where user details can be fetched.
- Once done, click Proceed.
- Click Test Action to test the configured action.
- The output will be shown as follows. Click the Save and Exit button.
Create an Entry
This action lets you create an entry automatically in your stack. To know more, visit Create entries.
- Under Choose an Action tab, select the Create Entry action.
- In the Configure Action tab, click + Add New Account to add your Contentstack account.
- In the pop-up window, provide OAuth permissions for all the values by checking the boxes and click Authorize.
Note: Contentstack offers support for branches in Automation Hub. You must authenticate and re-authorize your existing account by checking all the permissions to add your Contentstack account.
- In the pop-up that appears, view the module-specific access rights provided to the app. Click Authorize to complete authorization.
- Provide an Account Name and click Save.
- Select a Stack, Branch, and Content Type from the Lookup list. Provide your entry data in the Entry Data field.
You can fetch the UID for all the previously configured automation steps directly from the Lookup list as shown below:Note: Provide your entry data as per your content type schema in JSON format only.
Note: By default, the main branch is selected (even if the Branch field is empty).
- In the Entry Data field, you can add a predefined schema template for your entry data. This will add a structure to provide your entry data in a particular format for different fields.
Note: You must manually configure the entry data for JSON Rich Text Editor, Custom, and Experience Container fields.
- [Optional] Enable the Show optional fields toggle button to display the Locale. You can also include the branch details by clicking the Include branch checkbox.
- Once done, click Proceed.
- Click Test Action to test the configured action.
- The output will be shown as follows. Click the Save and Exit button to finish setting up the Create Entry action for the Contentstack connector.
Entry Workflow Stage
This action lets you set the workflow stage for your entry. Read more about workflow stages.
- Under Choose an Action tab, select the Set Entry Workflow action.
- In the Configure Action tab, click + Add New Account to add your Contentstack account.
- In the pop-up window, provide OAuth permissions for all the values by checking the boxes and click Authorize.
Note: Contentstack offers support for branches in Automation Hub. You must authenticate and re-authorize your existing account by checking all the permissions to add your Contentstack account.
- In the pop-up that appears, view the module-specific access rights provided to the app. Click Authorize to complete authorization.
- Provide an Account Name and click Save.
- Select a Stack, Branch, and Content Type from the Lookup list. Also, select an Entry from the Lookup list for which you want to set the workflow stage.
- Select the Workflow Stage ID from the Lookup list.
Note: If you select the Workflow Stage ID as Next Stage, the workflow stage of the selected entry will be updated automatically to the next stage. And, if your entry has reached the last stage of the workflow, a success message will be shown for the completed workflow.
Note: By default, the main branch is selected (even if the Branch field is empty).
- [Optional] Enable the Show optional fields toggle button to display the Due Date, Comment, and Locale fields.
- Set a Due Date. This defines a date for the entry stage to be completed. With Notify via Email, you can choose to notify other members in the workflow about the action changes via email.
- Under Comment, add a comment for the next stage user.
- Select a Locale from the Lookup list in which you want to set the workflow stage.
- Click Proceed.
- Click Test Action to test the configured action.
- If the setup is successful, you will see the following output. Click Save and Exit.
Localize an Entry
This action lets you create localized versions of your entries. Here’s a link to know more about Localization.
- Under Choose an Action tab, select the Localize an Entry action.
- In the Configure Action tab, click + Add New Account to add your Contentstack account.
- In the pop-up window, provide OAuth permissions for all the values by checking the boxes and click Authorize.
Note: Contentstack offers support for branches in Automation Hub. You must authenticate and re-authorize your existing account by checking all the permissions to add your Contentstack account.
- In the pop-up that appears, view the module-specific access rights provided to the app. Click Authorize to complete authorization.
- Provide an Account Name and click Save.
- Select the Stack, Branch ,Content Type, Entry, and Locale from the Lookup list.
You can fetch the UID for all the previously configured automation steps directly from the Lookup list as shown below:Note: Locale provides a list of languages present in your stack.
Note: By default, the main branch is selected (even if the Branch field is empty).
- Provide your entry data in the Entry Data field.
Note: Provide your entry data in JSON format as per your content type schema.
- [Optional] Enable the Show optional fields toggle button to display the Include branch checkbox to include the branch details.
- Click Proceed.
- Click Test Action to test the configured action.
- The output will be shown as follows. Click the Save and Exit button to finish setting up the Localize an Entry action for the Contentstack connector.
Publish an Entry
This action lets you publish an entry automatically in your stack. To know more, visit publish entries.
- Under Choose an Action tab, select Publish Entry action.
- In the Configure Action tab, click + Add New Account to add your Contentstack account.
- In the pop-up window, provide OAuth permissions for all the values by checking the boxes and click Authorize.
Note: Contentstack offers support for branches in Automation Hub. You must authenticate and re-authorize your existing account by checking all the permissions to add your Contentstack account.
- In the pop-up that appears, view the module-specific access rights provided to the app. Click Authorize to complete authorization.
- Provide an Account Name and click Save.
- Select a Stack, Branch, Content Type, Entry from the Lookup list.
You can fetch the UID for all the previously configured automation steps directly from the Lookup list as shown below:
Note: By default, the main branch is selected (even if the Branch field is empty).
- Select an Environment from the Lookup list where you want to publish the entry.
- [Optional] Enable the Show optional fields toggle button to display the Locale and Publish Schedule fields.
- Once done, click Proceed.
- Click Test Action to test the configured action.
- On successful configuration, you can see the below output. Click Save and Exit.
Publish an Asset
This action lets you publish an asset automatically in your stack. To know more, visit publish assets.
- Under Choose an Action tab, select Publish Asset action.
- In the Configure Action tab, click + Add New Account to add your Contentstack account.
- In the pop-up window, provide OAuth permissions for all the values by checking the boxes and click Authorize.
Note: Contentstack offers support for branches in Automation Hub. You must authenticate and re-authorize your existing account by checking all the permissions to add your Contentstack account.
- In the pop-up that appears, view the module-specific access rights provided to the app. Click Authorize to complete authorization.
- Provide an Account Name and click Save.
- Select a Stack, Branch, and an Asset from the Lookup list.
You can fetch the UID for all the previously configured automation steps directly from the Lookup list as shown below:Note: To dynamically fetch assets, configure the Asset Trigger and fetch the asset UID.
Note: By default, the main branch is selected (even if the Branch field is empty).
- Select an Environment from the Lookup list where you want to publish the asset.
- [Optional] Enable the Show optional fields toggle button to display the Locale and Publish Schedule fields.
- Once done, click Proceed.
- Click Test Action to test the configured action.
- On successful configuration, you can see the below output. Click Save and Exit. A publish and unpublish icon will appear for the asset on the entry page.
Unpublish an Entry
This action lets you unpublish an entry automatically in your stack. To know more, visit unpublish entries.
- Under Choose an Action tab, select Unpublish Entry action.
- In the Configure Action tab, click + Add New Account to add your Contentstack account.
- In the pop-up window, provide OAuth permissions for all the values by checking the boxes and click Authorize.
Note: Contentstack offers support for branches in Automation Hub. You must authenticate and re-authorize your existing account by checking all the permissions to add your Contentstack account.
- In the pop-up that appears, view the module-specific access rights provided to the app. Click Authorize to complete authorization.
- Provide an Account Name and click Save.
- Select a Stack, Branch, Content Type, and Entry from the Lookup list.
You can fetch the UID for all the previously configured automation steps directly from the Lookup list as shown below:
- Select an Environment from where you want to unpublish the entry.
Note: Unpublishing an entry can only be done for one environment at a time.
- [Optional] Enable the Show optional fields toggle button to display the Locale and Unpublish Schedule fields.
- Once done, click Proceed.
- Click Test Action to test the configured action.
- On successful configuration, you can see the below output. Click Save and Exit.
Get Single Entry
This action lets you fetch details of a single entry in your stack.
- Under Choose an Action tab, select Get Single Entry action.
- In the Configure Action tab, click + Add New Account to add your Contentstack account.
- In the pop-up window, provide OAuth permissions for all the values by checking the boxes and click Authorize.
Note: Contentstack offers support for branches in Automation Hub. You must authenticate and re-authorize your existing account by checking all the permissions to add your Contentstack account.
- In the pop-up that appears, view the module-specific access rights provided to the app. Click Authorize to complete authorization.
- Provide an Account Name and click Save.
- Select a Stack, Branch, Content Type, and Entry from the Lookup list.
You can fetch the UID for all the previously configured automation steps directly from the Lookup list as shown below:Note: By default, the main branch is selected (even if the Branch field is empty).
- [Optional] Enable the Show optional fields toggle button to display additional fields. Select the entry Version and Locale and check the Include Workflow, Include Publish Details, and Include branch checkboxes to fetch these details in addition to the entry details.
- Once done, click Proceed.
- Click Test Action to test the configured action.
- On successful configuration, you can see the below output. Click Save and Exit.
Update Entry
This action lets you update an entry automatically in your stack.
- Under Choose an Action tab, select Update Entry action.
- In the Configure Action tab, click + Add New Account to add your Contentstack account.
- In the pop-up window, provide OAuth permissions for all the values by checking the boxes and click Authorize.
Note: Contentstack offers support for branches in Automation Hub. You must authenticate and re-authorize your existing account by checking all the permissions to add your Contentstack account.
- In the pop-up that appears, view the module-specific access rights provided to the app. Click Authorize to complete authorization.
- Provide an Account Name and click Save.
- Select a Stack, Branch, Content Type, Entry Data, and Entry from the Lookup list.
You can fetch the UID for all the previously configured automation steps directly from the Lookup list as shown below:Note: Enter the data in JSON format only.
Note: By default, the main branch is selected (even if the Branch field is empty).
- In the Entry Data field, you can add a predefined schema template for your entry data. This will add a structure to provide your entry data in a particular format for different fields.
Note: You must configure the entry data for JSON Rich Text Editor, Custom, and Experience Container fields manually.
- [Optional] Enable the Show optional fields toggle button to display additional fields. Select the Locale and check the Include branch checkbox to fetch these details in addition to the entry details.
- Once done, click Proceed.
- Click Test Action to test the configured action.
- On successful configuration, you can see the below output. Click Save and Exit.