cs-icon.svg

Contentstack Management

The Contentstack Management connector lets you perform specific actions within your stack. With this connector, you can perform CRUD operations on entries, releases, content types, assets, and user specific information such as first name, last name, etc.

Details of each action are covered in their respective sections.

Prerequisites

To use the Contentstack Management connector, you first need to add your Contentstack account. To do so, follow the steps given below:

Connect your Contentstack Account to Automate

  1. Click Configure Action Step from the left navigation panel.
  2. Click Action Step to configure third-party services.
  3. Within the Configure Action Step, click the Contentstack connector.
    Contentstack_Action.png
  4. Select the Contentstack Management connector to perform CMS tasks.
    Select_Connector_Category.png
  5. Under Choose an Action tab, select any one action from the list. Here, we are selecting the Get All Content Types action.
    Get_All_Content_Types.png
  6. On the Configure Action page, click the + Add New Account to add your Contentstack account.
    Add_Account.png
  7. Select a way to add a new account. You can authenticate your account in two ways: Contentstack OAuth or Management Token.
    Authorize_Account.png
    1. If you select Contentstack OAuth and click Proceed, the Manage Permissions modal will open, as shown below. Provide the OAuth permissions for all the values by checking the boxes and click Authorize
      Authorize_Contentstack.png

      Note: Contentstack offers support for Branches in Automate. You must authenticate and re-authorize your existing account by checking all the permissions to add your Contentstack account.

    2. In the pop-up, select your organization to complete the authorization.
      Select_Organization.png
    3. In the pop-up that appears, view the module-specific access rights provided to the app. Click Authorize to complete authorization.
      Authorize_Organization.png
    4. Provide an Account Name and then click Save.
      Save_Account.png
    5. If you select Management Token and click Proceed, the Authorize modal will open, as shown below. Enter a Title and the Management Token of your stack and click Authorize.
      Authorize_Button.png

Once done, you can go ahead and set up your Contentstack Management action connector.

Set up the Contentstack Management Connector

Perform the following steps to set up the Contentstack Management connector:

  1. From the left navigation panel, click Configure Action Step.
  2. Then, click Action Step to configure third-party services.
  3. Within the Configure Action Step, click the Contentstack connector.
    Contentstack_Action.png

    Note: You can sort and search the connector(s) based on the filter.

  4. Select the Contentstack Management connector to perform CMS tasks.
    Select_Connector_Category.png
  5. Under Choose an Action, you will see five categories of actions: Asset, Content Type, Entry, Release and User.
    Category_Action.png

Let’s look at each of them in detail.

Assets

You can perform asset based operations using these actions.

Asset.png

Let’s look at each of them in detail.

Create an Asset

This action lets you create a new asset in Contentstack.

  1. Under Choose an Action tab, select the Create an Asset action.
  2. Click + Add New Account button to connect your Contentstack account as shown in the Connect your Contentstack Account to Automate step.
  3. Select a Stack from the Lookup list and enter a Title for the asset.
  4. Specify a File Name for the asset, such as ‘NewAsset.png’ or ‘NewAsset.jpeg.’
    Select_Fields
  5. Enter the Input URL of the image you want to create and specify a suitable Description for the asset.
    Select_input_URL_Description
  6. Optionally, enable the Show Optional Fields toggle button to display the Select Folder field.
  7. In the Select Folder drop-down, choose a destination folder to store your asset.
    Show_Optional_Fields
  8. Once done, click Proceed.
  9. Click Test Action to test the configured action.
    Test_Action
  10. On successful configuration, you can see the below output. Click Save and Exit.
    Contentstack_Action_Create_an_asset_Save_Exit.png

Get All Assets

This action lets you fetch details of all the assets in your stack.

  1. Under Choose an Action tab, select the Get All Assets action.
  2. Click + Add New Account button to connect your Contentstack account as shown in the Connect your Contentstack Account to Automate step.
  3. Select a Stack, Environment, and Branch from the Lookup list.
    Select_Fields.png

    Note: By default, the main branch is selected (even if the Branch field is empty).

  4. Optionally, enable the Show Optional Fields toggle button to display the Asset Limit, Skip Asset (Pagination) fields.
  5. In the Select Folder drop-down, select a folder to fetch the details of all the assets present in the folder.

    Additionally, you can mark the Include count, Include publish details and Include metadata checkboxes to display the count of the total number of assets, publish and metadata details in the output.

    Show_Optional_Fields.png

  6. Once done, click Proceed.
  7. Click Test Action to test the configured action.
    Test_Action
  8. The output will be shown as follows. Click the Save and Exit button.
    Save_And_Exit.png

Get a Single Asset

  1. Under Choose an Action tab, select the Get a Single Asset action.
  2. Click + Add New Account button to connect your Contentstack account as shown in the Connect your Contentstack Account to Automate step.
  3. Select a Stack, Environment, Asset, and Branch from the Lookup list.
    Select_Different_Field.png

    Note: By default, the main branch is selected (even if the Branch field is empty).

  4. Optionally, enable the Show Optional Fields toggle button to display additional fields. Enter the asset Version to fetch the details of the asset. 
    Show_Optional_Fields.png
  5. Once done, click Proceed.
  6. Click Test Action to test the configured action.
    Test_Action
  7. The output will be shown as follows. Click the Save and Exit button.
    Save_Exit.png

Publish an Asset

This action lets you publish an asset automatically in your stack. To know more, visit publish assets.

  1. Under Choose an Action tab, select the Publish an Asset action.
  2. On the Publish an Asset Configure Action page, enter the details given below:
    1. Click + Add New Account button to connect your Contentstack account as shown in the Connect your Contentstack Account to Automate step.
    2. 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.

      Suggested_Data_Elements.png

      Note: By default, the main branch is selected (even if the Branch field is empty).

    3. Select the Environment(s) from the Lookup list where you want to publish the asset.
      Select_Fields.png
    4. [Optional] Enable the Show Optional Fields toggle button to display the Select Locale(s) and Publish Schedule fields.
      Show_Optional_Fields.png

      Note: You can select multiple Environment(s) and Locale(s) to publish the asset.

  3. Once done, click Proceed
  4. Click Test Action to test the configured action.
    Test_Action.png
  5. 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.
    Save_Exit.png

Update an Asset

This action lets you update an existing asset in Contentstack.

  1. Under Choose an Action tab, select the Update an Asset action.
  2. Click + Add New Account button to connect your Contentstack account as shown in the Connect your Contentstack Account to Automate step.
  3. Select a Stack and an Asset from the Lookup list.
  4. Enter a Title and a suitable Description for the asset to update.
  5. Specify a File Name for the asset, such as ‘Travel_Friendly.png’ or ‘Travel_Friendly.jpeg.’ Enter the Input URL of the image you want to update.
    Contentstack_Action_Update_an_asset_Select_File_name_Input_URL.png
  6. Optionally, enable the Show Optional Fields toggle button to display the Select Folder field.
  7. In the Select Folder drop-down, choose a destination folder to update an asset in it.
    Select_Folder
  8. Once done, click Proceed.
  9. Click Test Action to test the configured action.
    Test_Action
  10. On successful configuration, you can see the below output. Click Save and Exit.
    Contentstack_Action_Update_an_asset_Save_Exit.png

Content Types

By using this action, you can fetch all content types from a selected stack.

Content_Type.png

Let’s look at the action in detail.

Get All Content Types

This action fetches all the content types present in a stack.

  1. Under Choose an Action tab, select the Get All Content Types action.
  2. Click + Add New Account button to connect your Contentstack account as shown in the Connect your Contentstack Account to Automate step.
  3. 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.
    Select_Different_Fields

    Note: By default, the main branch is selected (even if the Branch field is empty).

  4. [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.
  5. 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.

    Select_Show_Optional_Fields

    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.

  6. Once done, click Proceed.
  7. Click Test Action to test the configured action.
    Test-Action
  8. The output will be shown as follows. Click the Save and Exit button.
    Save_and_Exit

Entry

You can perform entry based operations using this action.

Entry.png

Let’s look at each of these in detail.

Create an Entry

This action lets you create an entry automatically in your stack. To know more, visit Create entries.

  1. Under Choose an Action tab, select the Create an Entry action.
  2. Click + Add New Account button to connect your Contentstack account as shown in the Connect your Contentstack Account to Automate step.
  3. 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.

    Select_Different_Fields

    Note: By default, the main branch is selected (even if the Branch field is empty).

  4. 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.

    Select_Entry_Data_Field
  5. [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.
    Select_Show_Optional_Fields
  6. Once done, click Proceed.
  7. Click Test Action to test the configured action.
    Test_Action
  8. 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.
    Save_Exit

Delete an Entry

This action deletes an entry in a stack.

  1. Under Choose an Action tab, select the Delete an Entry action.
  2. On the Delete an Entry Configure Action page, enter the details given below:
    1. Click + Add New Account button to connect your Contentstack account as shown in the Connect your Contentstack Account to Automate step.
    2. Select a Stack, Branch, Content Type, and Entry from the Lookup list.
      Select_Entry.png

      Note: By default, the main branch is selected (even if the Branch field is empty).

    3. [Optional] Enable the Show Optional Fields toggle button to display the Select Locale(s) field.

      Note: You can select multiple Locale(s) to delete the entry saved in that locale.

    4. 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.

      Show_Optional_Fieds.png

      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.

  3. Once done, click Proceed.
  4. Click Test Action to test the configured action.
    Test_Action.png
  5. The output will be shown as follows. Click the Save and Exit button.
    Save_Exit.png

Get All Entries

This action fetches all the entries present in a stack.

  1. Under Choose an Action tab, select the Get All Entries action.
  2. Click + Add New Account button to connect your Contentstack account as shown in the Connect your Contentstack Account to Automate step.
  3. 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:
    Suggested_Data_Elements
    Select_Different_Fields

    Note: By default, the main branch is selected (even if the Branch field is empty).

  4. [Optional] Enable the Show Optional Fields toggle button to display the Entry Limit, Skip Entry (Pagination), Entry Version, and Select Locale fields.
    Select_Show_Optional_Field_1
  5. 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:
    Customized_Query

    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.

    Add_Customized_Query

    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.

    Reference_Fields

    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.

  6. Once done, click Proceed.
  7. Click Test Action to test the configured action.
    Test-Action
  8. The output will be shown as follows. Click the Save and Exit button.
    Save_and_Exit_Button

Get a Single Entry

This action lets you fetch details of a single entry in your stack.

  1. Under Choose an Action tab, select the Get a Single Entry action.
  2. Click + Add New Account button to connect your Contentstack account as shown in the Connect your Contentstack Account to Automate step.
  3. 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:
    Suggested_Data_Elements

    Note: By default, the main branch is selected (even if the Branch field is empty).

  4. [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.
    Show_Optional_Fields
  5. Once done, click Proceed.
  6. Click Test Action to test the configured action.
    Test_Action
  7. On successful configuration, you can see the below output. Click Save and Exit.
    Save_Exit

Localize an Entry

This action lets you create localized versions of your entries. Here’s a link to know more about Localization.

  1. Under Choose an Action tab, select the Localize an Entry action.
  2. Click + Add New Account button to connect your Contentstack account as shown in the Connect your Contentstack Account to Automate step.
  3. 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:
    Suggested_Data_Elements

    Note: Locale provides a list of languages present in your stack.

    Select_Different_Fields

    Note: By default, the main branch is selected (even if the Branch field is empty).

  4. Provide your entry data in the Entry Data field.

    Note: Provide your entry data in JSON format as per your content type schema.

  5. [Optional] Enable the Show Optional Fields toggle button to display the Include branch checkbox to include the branch details.
    Select_Entry_Data
  6. Click Proceed.
  7. Click Test Action to test the configured action.
    Test_Action
  8. 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.
    Save_and_Exit

Publish a Queue

This action fetches all the entries present in the Publish Queue in Contentstack.

  1. Under Choose an Action tab, select the Publish a Queue action.
  2. Click + Add New Account button to connect your Contentstack account as shown in the Connect your Contentstack Account to Automate step.
  3. Select a Stack and Branch from the Lookup list.
    Select_Different_Fields

    Note: By default, the main branch is selected (even if the Branch field is empty).

  4. [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.
  5. 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.

    Show_Optional_Fields
  6. Once done, click Proceed.
  7. Click Test Action to test the configured action.
    Test_Action
  8. The output will be shown as follows. Click the Save and Exit button.
    Save_and-Exit

Publish an Entry

This action lets you publish an entry automatically in your stack. To know more, visit publish entries.

  1. Under Choose an Action tab, select the Publish an Entry action.
  2. On the Publish an Entry Configure Action page, enter the details given below:
    1. Click + Add New Account button to connect your Contentstack account as shown in the Connect your Contentstack Account to Automate step.
    2. 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.
      Select_Fields.png

      Note: By default, the main branch is selected (even if the Branch field is empty).

    3. Select the Environment(s) and Locale(s) from the Lookup list where you want to publish the entry.
      Select_Locale_Environment.png
    4. [Optional] Enable the Show Optional Fields toggle button to display the Publish Schedule field. Click the Nested Reference Publishing checkbox to publish the entry along with the referenced entries. Learn more about Nested Reference Publishing.
      Show_Optional_Fields.png

      Note: You can select multiple Environment(s) and Locale(s) to publish the entry.

  3. Once done, click Proceed.
  4. Click Test Action to test the configured action.
    Test_Action.png
  5. On successful configuration, you can see the below output. Click Save and Exit.
    Save_and_Exit.png

Set Entry Workflow

This action lets you set the workflow stage for your entry. Read more about workflow stages.

  1. Under Choose an Action tab, select the Set Entry Workflow action.
  2. On the Set Entry Workflow Configure Action page, enter the details given below:
    1. Click + Add New Account button to connect your Contentstack account as shown in the Connect your Contentstack Account to Automate step.
    2. 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.
    3. 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.

      Select_Fields.png

      Note: By default, the main branch is selected (even if the Branch field is empty).

    4. [Optional] Enable the Show Optional Fields toggle button to display the Set Due Date, Comment, Assignee Name(s), Assignee Role(s), and Select Locale fields.
    5. Select the Assignee Name(s) and Assignee Role(s). With the Assignee Name(s), you can add the user to review the workflow updates, send an email notification and add comments for the assignee.
      With the Assignee Role(s), you can add the users with similar roles, such as developers, testers to check the workflow updates.
      Assignee_Name_Role.png

      Note: You can select multiple Assignee Name(s) and Assignee Role(s) to let the users know about the workflow update.

    6. 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.
    7. Under Comment, add a comment for the next stage user.
      Due_Date_Comment.png
    8. Select a Locale from the Lookup list in which you want to set the workflow stage.
      Locale.png
  3. Click Proceed.
  4. Click Test Action to test the configured action.
    Test_Action.png
  5. If the setup is successful, you will see the following output. Click Save and Exit.
    Save_Exit.png

Unpublish an Entry

This action lets you unpublish an entry automatically in your stack. To know more, visit unpublish entries.

  1. Under Choose an Action tab, select the Unpublish an Entry action.
  2. On the Unpublish an Entry Configure Action page, enter the details given below:
    1. Click + Add New Account button to connect your Contentstack account as shown in the Connect your Contentstack Account to Automate step.
    2. 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.
      Select_Fields.png
    3. Select the Environment(s) from where you want to unpublish the entry. Select_Env.png
    4. [Optional] Enable the Show Optional Fields toggle button to display the Select Locale(s) and Unpublish Schedule fields.
      Show_optional_Field.png

      Note: You can select multiple Environment(s) and Locale(s) to unpublish the entry.

  3. Once done, click Proceed.
  4. Click Test Action to test the configured action.
    Test_Action.png
  5. On successful configuration, you can see the below output. Click Save and Exit.
    Save_Exit.png

Update an Entry

This action lets you update an entry automatically in your stack.

  1. Under Choose an Action tab, select the Update an Entry action.
  2. Click + Add New Account button to connect your Contentstack account as shown in the Connect your Contentstack Account to Automate step.
  3. 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.

    Suggested_Data_Elements

    Note: By default, the main branch is selected (even if the Branch field is empty).

  4. 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.

    Select_Different_Field_Entry_Data
  5. [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. 
    Show_Optional_Fields
  6. Once done, click Proceed.
  7. Click Test Action to test the configured action.
    Test_Action
  8. On successful configuration, you can see the below output. Click Save and Exit.
    Save_and_Exit

Release

You can perform release based operations using this action.

Releasae.png

Let’s look at each of these in detail.

Add Items to a Release

This action lets you add multiple items to a release.

  1. Under Choose an Action tab, select the Add Items to a Release action.
  2. Click + Add New Account button to connect your Contentstack account as shown in the Connect your Contentstack Account to Automate step.
  3. 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.

    Select_Different_Fields

    Note: By default, the main branch is selected (even if the Branch field is empty).

  4. [Optional] Enable the Show Optional Fields toggle button to display the branch details by clicking the Include branch checkbox.
    Show_Optional_Fields
  5. Once done, click Proceed.
  6. Click Test Action to test the configured action.
    Test_Action
  7. The output will be shown as follows. Click the Save and Exit button.
    Clcik_the_Save_And_Exit_Button

Clone a Release

This action lets you create a copy of a release.

  1. Under Choose an Action tab, select the Clone a Release action.
  2. Click + Add New Account button to connect your Contentstack account as shown in the Connect your Contentstack Account to Automate step.
  3. Select a Stack, Branch, and Release from the Lookup list.
    Select_Different_Fields

    Note: By default, the main branch is selected (even if the Branch field is empty).

  4. Provide a Release Name and a Release Description for the release to be created.
    Select_Release_Name_And_Description
  5. [Optional] Enable the Show optional fields toggle button to display the branch details by clicking the Include branch checkbox.
    Show_Optional_Fields
  6. Once done, click Proceed.
  7. Click Test Action to test the configured action.
    Test_Action
  8. The output will be shown as follows. Click the Save and Exit button.
    Cliik_the_Save_And_Exit_Button

Create a Release

This action lets you create a release.

  1. Under Choose an Action tab, select the Create a Release action.
  2. Click + Add New Account button to connect your Contentstack account as shown in the Connect your Contentstack Account to Automate step.
  3. Select a Stack, Release Name, Release Description, and Branch from the Lookup list.
    Select_Different_Fields

    Note: By default, the main branch is selected (even if the Branch field is empty).

  4. [Optional] Enable the Show Optional Fields toggle button to display the branch details by clicking the Include branch checkbox.
    Show_Optional_Fields
  5. Once done, click Proceed.
  6. Click Test Action to test the configured action.
    Test_Action
  7. The output will be shown as follows. Click the Save and Exit button.
    Save_And_Exit

Delete Items from a Release

This action lets you delete multiple items from a release.

  1. Under Choose an Action tab, select the Delete Items from a Release action.
  2. Click + Add New Account button to connect your Contentstack account as shown in the Connect your Contentstack Account to Automate step.
  3. 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. 

    Select_Different_Fields

    Note: By default, the main branch is selected (even if the Branch field is empty).

  4. [Optional] Enable the Show Optional Fields toggle button to display the branch details by clicking the Include branch checkbox.
    Show_Optional_Fields
  5. Once done, click Proceed.
  6. Click Test Action to test the configured action.
    Test_Action
  7. The output will be shown as follows. Click the Save and Exit button.
    Save_And_Exit

Deploy a Release

This action lets you deploy a release to an environment.

  1. Under Choose an Action tab, select the Deploy a Release action.
  2. On the Deploy a Release Configure Action page, enter the details given below:
    1. Click + Add New Account button to connect your Contentstack account as shown in the Connect your Contentstack Account to Automate step.
    2. Select a Stack, Branch, and Release from the Lookup list.
      Select_fields.png

      Note: By default, the main branch is selected (even if the Branch field is empty).

    3. Select the Environment(s) to deploy the release from the Lookup list.
      Select_Environment.png
    4. [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.

      Publish_Schedule.png
  3. Once done, click Proceed.
  4. Click Test Action to test the configured action.
    Test_Action.png
  5. The output will be shown as follows. Click the Save and Exit button.
    Save_Exit.png

Get All Items in a Release

This action fetches all the items present in a release.

  1. Under Choose an Action tab, select the Get All Items in a Release action.
  2. Click + Add New Account button to connect your Contentstack account as shown in the Connect your Contentstack Account to Automate step.
  3. Select a Stack, Branch, and Release from the Lookup list.
    Select_Different_Fields

    Note: By default, the main branch is selected (even if the Branch field is empty).

  4. [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.
    Show_Optional_Fields
  5. Once done, click Proceed.
  6. Click Test Action to test the configured action.
    Test_Action
  7. The output will be shown as follows. Click the Save and Exit button.
    Save_Exit

Get All Releases

This action fetches all the releases present in a stack.

  1. Under Choose an Action tab, select the Get All Releases action.
  2. Click + Add New Account button to connect your Contentstack account as shown in the Connect your Contentstack Account to Automate step.
  3. 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.
    Select_Different_Fields

    Note: By default, the main branch is selected (even if the Branch field is empty).

  4. [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.
    Show_Optional_Fields
  5. Once done, click Proceed.
  6. Click Test Action to test the configured action.
    Test_Action
  7. The output will be shown as follows. Click the Save and Exit button.
    Save_Exit

Get a Single Release

This action fetches the details of a single release.

  1. Under Choose an Action tab, select the Get a Single Release action.
  2. Click + Add New Account button to connect your Contentstack account as shown in the Connect your Contentstack Account to Automate step.
  3. Select a Stack, Branch, and Release from the Lookup list.
    Select_Different_Fields

    Note: By default, the main branch is selected (even if the Branch field is empty).

  4. [Optional] Enable the Show Optional Fields toggle button to display the branch details by clicking the Include branch checkbox.
    Show_Optional_Fields
  5. Once done, click Proceed.
  6. Click Test Action to test the configured action.
    Test_Action
  7. The output will be shown as follows. Click the Save and Exit button.
    Save_Exit

User

By using this action, you can fetch user related details, such as name, email, and so on.

User_Information.png

Let’s look at the action in detail.

Get User Information

This action gets a user's first name, last name and email address based on the user ID.

  1. Under Choose an Action tab, select the Get User Information action.
  2. Click + Add New Account button to connect your Contentstack account as shown in the Connect your Contentstack Account to Automate step.
  3. 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.

    Select_User_ID
  4. Once done, click Proceed.
  5. Click Test Action to test the configured action.
    Test_Action
  6. The output will be shown as follows. Click the Save and Exit button.
    Save_Exit

This sets the Contentstack Management connector.

Was this article helpful?
^