Contentful

Create, update, and publish entries in your Contentful content infrastructure.

On this page

Connect
Call it from a workflow
Actions (4)
contentful_record_create
contentful_record_get
contentful_record_search
custom_api_call
Details

Connect

Auth type: API key (secret_text). Paste the API key (or token) from the provider's settings into the connect dialog. It is encrypted at rest and only decrypted on the server when an action runs.

In the editor: Backend panel, Integrations tab, then Connect. This connects it for the project.
For every project in a workspace: Workspace settings, Integrations.
Owners and admins choose which integrations members may connect in the admin panel (Integrations tab), and can attach their own OAuth app there.

Call it from a workflow

Pass the action name and its input. The call resolves with { success, output, error? }; a missing connection resolves with success false and the reason. See ctx.integrations.invoke and ctx.integrations.call.

Native workflow

// .workflow.js (native ctx)
export async function run(ctx) {
  const res = await ctx.integrations.invoke("contentful", "contentful_record_create", {
    "locale": "<locale>",
    "contentModel": "<contentModel>",
    "publishOnCreate": true,
    "fields": {}
  });
  if (!res.success) throw new Error(res.error);
  ctx.log.info("Contentful answered", { output: res.output });
}

defineWorkflow module

// defineWorkflow module (@app/sdk ctx)
import { defineWorkflow } from "@app/sdk";

export default defineWorkflow({
  id: "contentful-contentful-record-create",
  name: "Contentful: Create Record",
  description: "Calls Contentful when a row is created.",
  trigger: { type: "entity_event", entity: "tickets", event: "created" },
  async run(ctx, event) {
    const res = await ctx.integrations.call("contentful", {
      "action": "contentful_record_create",
      "locale": "<locale>",
      "contentModel": "<contentModel>",
      "publishOnCreate": true,
      "fields": {}
    }) as { success: boolean; error?: string };
    if (!res.success) throw new Error(res.error);
  },
});

From an app (connector proxy)

curl -X POST "$APP_ORIGIN/__appbricx/connector-proxy/contentful/contentful_record_create" \
  -H "Authorization: Bearer $APP_KEY" \
  -H "content-type: application/json" \
  -d '{"props":{"locale":"<locale>","contentModel":"<contentModel>","publishOnCreate":true,"fields":{}}}'

Actions

contentful_record_createin catalog

Create Record. Creates a new Contentful record for a given Content Model

Input	Type	Description
`locale`required	id (picked from your account)	Content Locale
`contentModel`required	id (picked from your account)	Content Model
`publishOnCreate`required	boolean	Whether or not to publish this record after creating it.
`fields`required	object (depends on other props)	Fields for Content Model

contentful_record_getin catalog

Get Record. Gets a Contentful record for a given Content Model

Input	Type	Description
`entityId`required	text	The ID of the record to get.

contentful_record_searchin catalog

Search Records. Searches for records of a given Content Model

Input	Type	Description
`contentModel`required	id (picked from your account)	Content Model
`locale`required	id (picked from your account)	Content Locale
`query`required	JSON	The query formula to use to search for records. See https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/search-parameters for more information
`limit`optional	number	The maximum number of records to return
`skip`optional	number	The number of records to skip
`include`optional	number	Number of levels to include for entries and assets. See https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/resource-links/retrieval-of-linked-resource-links
`select`optional	ids (picked from your account)	The fields to return for each record.

custom_api_call

Custom API Call. Make a custom API call to a specific endpoint

Input	Type	Description
`url`required	object (depends on other props)	url
`method`required	one of "GET" \| "POST" \| "PATCH" \| "PUT" \| "DELETE" \| "HEAD"	Method
`headers`required	object	Authorization headers are injected automatically from your connection.
`queryParams`required	object	Query Parameters
`body_type`optional	one of "none" \| "json" \| "form_data" \| "raw"	Body Type
`body`optional	object (depends on other props)	Body
`response_is_binary`optional	boolean	Enable for files like PDFs, images, etc.
`failsafe`optional	boolean	No Error on Failure
`timeout`optional	number	Timeout (in seconds)
`followRedirects`optional	boolean	Follow redirects

Details

Id: contentful
Category: Content
Tags: cms, headless, content, api-first
Package: @activepieces/piece-contentful@0.1.4
Tier: Built in