Skip to content
Help Center

Strapi integration overview

Last updated on .

View Markdown Contact support Contact support 4 min read
On this page

Overview

Strapi is an open-source headless content management system (CMS). Teams use Strapi to create, manage, and deliver content through APIs.

Persona’s Strapi integration lets a Workflow list, create, get, update, and delete entries in a Strapi collection type, such as articles or products. For example, a Workflow can write verification outcomes or reviewed submissions into a content collection. A Workflow can also look up entries to decide what to do next, or keep a content record in sync as the Workflow continues.

Integration features

  • List entries: Get the entries of a collection type. You can control pagination, sorting, the fields to return, the related content to include, draft or published status, and locale.
  • Create entry: Add an entry to a collection type.
  • Get entry: Get one entry by its Document ID.
  • Update entry: Change an entry by its Document ID.
  • Delete entry: Permanently delete an entry by its Document ID.

The integration works with the entries of collection types only. It cannot create or list content types.

Prerequisites

Before you configure the integration, you need:

  • A Strapi instance, self-hosted or on Strapi Cloud. The instance must be reachable over HTTPS from the internet.
  • The collection type that you want to use. It must already exist in Strapi, because the integration cannot create content types.
  • Admin access to your Strapi instance, so that you can create an API token.

Set up Strapi credentials

  1. In the Strapi admin panel, go to Settings > Global Settings > API Tokens.

  2. Click Create new API Token and enter a name for the token.

  3. Select a token duration. Select Unlimited, or select a fixed duration if you rotate your tokens.

  4. Select the Custom token type. Enable only the actions that your Workflows use (find, findOne, create, update, and delete) for the content types that they use.

    The Full access token type also works, but it gives the token more access than the integration needs.

  5. Click Save. Copy the token immediately, because Strapi shows it one time only.

  6. In the Persona Dashboard, go to Integrations > Marketplace and select Strapi.

  7. Click Add Credential and enter a nickname for the credential.

  8. Enter the host of your Strapi instance, for example my-project.strapiapp.com. Enter the host only, without https:// and without a trailing slash.

  9. Paste the Strapi API token and save the credential.

Use Strapi in a Workflow

  1. Create a Workflow, or open the Workflow you want to update.
  2. Add an Action step and select Integrations.
  3. Select Strapi, choose the saved credential, and select an action.
  4. Map Persona data to the action’s input fields.
  5. Save and publish the Workflow.

Find the values that actions use

  • Content Type API ID: The plural API ID of the collection type, for example articles. The Content-Type Builder in Strapi shows this value.
  • Document ID: The documentId of an entry, as Strapi 5 names it. Use the Document ID, not the numeric id, because the numeric id can change when an entry is updated. Get the Document ID from the output of List entries or Create entry.

Strapi actions

  • List entries: Returns the entries of a collection type. Optional settings control pagination, sorting, the fields to return, the related content to include, draft or published status, and locale.
  • Create entry: Creates an entry in a collection type. The field names that you send must match the fields of the content type in the Strapi Content-Type Builder. An unknown field name returns a validation error.
  • Get entry: Returns one entry. Uses the Document ID of the entry.
  • Update entry: Changes an entry. Uses the Document ID of the entry. Only the fields that you send change. Strapi keeps the fields that you do not send as they are.
  • Delete entry: Permanently deletes an entry. Uses the Document ID of the entry.

Delete entry removes the entry permanently. Use Workflow conditions to control when a Workflow runs this action.

FAQs

Why does an action return a 403 Forbidden error?

Usually, the API token does not have permission for that action or that content type. In Strapi, edit the token and enable the action for the content type.

Why is a new entry not published?

If Draft & Publish is enabled for the content type, the entries that the integration creates can stay as drafts until someone publishes them in Strapi. Use the status filter in List entries or Get entry to get draft or published entries.

Which field names do I use?

The field names depend on your content model. Use the field names that the Content-Type Builder shows for the content type.

Plans Explained

Strapi Integration by plan

Startup ProgramEssential PlanGrowth PlanEnterprise Plan
Strapi IntegrationNot AvailableNot AvailableLimitedAvailable

Learn more about pricing and plans.

Was this page helpful?If something is missing, let us know and we will take a look.
Thanks for the feedback. It helps us improve these docs.