Skip to content
Blackbird docs

Contentstack

View on Github

Contentstack is a headless CMS technology assembled from a series of best-of-breed solutions. This Contentstack application primarily centers around entry and asset management.

Connecting

  1. Navigate to apps and search for Contentstack. If you cannot find Contentstack then click Add App in the top right corner, select Contentstack and add the app to your Blackbird environment.
  2. Click Add Connection.
  3. Name your connection for future reference e.g. ‘My client’.
  4. In the Host field input one of the following values: api.contentstack.io, eu-api.contentstack.com, azure-na-api.contentstack.com, azure-eu-api.contentstack.com
  5. Go to your Contentstack Stack settings and copy API key from the API Credentials section
  6. Paste it to the Stack API key field in Blackbird
  7. On the settings page go to Tokens, select Management Tokens section and generate API management token with the parameters you need.
  8. Copy it to the Management token field in Blackbird
  9. Click Connect.
  10. Confirm that the connection has appeared and the status is Connected.

Actions

Assets

  • Download/Upload asset downloads or uploads content for the asset.

Content types

  • List content types

Entries

  • Get entry returns details of the specific entry.
  • Get entry string/number/date/boolean property gets data of the specified entry’s property.
  • Set entry string/number/date/boolean property sets data to the specified entry’s property.
  • Search entries returns a list of entries based on provided filter criterias.
  • Get entry content as HTML returns entry content converted to an HTML file.
  • Update entry content from HTML updates entry content from HTML file.
  • Get IDs from HTML extracts content type and entry IDs from HTML file

Events

  • On asset deleted
  • On asset published
  • On asset unpublished
  • On entry created
  • On entry deleted
  • On entry published
  • On entry unpublished
  • On entry updated

HTML features

We add metadata to the HTML file to include Entry ID and Content Type ID. This metadata is used to update the entry content from the HTML file. These tags are used to identify the content in the Contentstack, eliminating the need to store IDs elsewhere.

Here is an example of how we include metadata in the HTML file:

<html>
    <head>
        <meta name="blackbird-content-type-id" content="your-content-type">
        <meta name="blackbird-entry-id" content="your-entry-id">
    </head>
    <body>
        <div path="title">Example HTML page</div>
        <div path="description">Blackbird is the new automation backbone for the language technology industry.</div>
    </body>
</html>

Feedback

Do you want to use this app or do you have feedback on our implementation? Reach out to us using the established channels or create an issue.