Cognito Forms

List forms and retrieve entries from Cognito Forms.

On this page

Connect
Call it from a workflow
Actions (5)
create_entry
delete_entry
get_entry
update_entry
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("cognito-forms", "create_entry", {
    "formId": "<formId>",
    "entryData": {}
  });
  if (!res.success) throw new Error(res.error);
  ctx.log.info("Cognito Forms answered", { output: res.output });
}

defineWorkflow module

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

export default defineWorkflow({
  id: "cognito-forms-create-entry",
  name: "Cognito Forms: Create Entry",
  description: "Calls Cognito Forms when a row is created.",
  trigger: { type: "entity_event", entity: "tickets", event: "created" },
  async run(ctx, event) {
    const res = await ctx.integrations.call("cognito-forms", {
      "action": "create_entry",
      "formId": "<formId>",
      "entryData": {}
    }) 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/cognito-forms/create_entry" \
  -H "Authorization: Bearer $APP_KEY" \
  -H "content-type: application/json" \
  -d '{"props":{"formId":"<formId>","entryData":{}}}'

Actions

create_entryin catalog

Create Entry. Creates a new entry.

Input	Type	Description
`formId`required	id (picked from your account)	Form
`entryData`required	object (depends on other props)	Fields

delete_entryin catalog

Delete Entry. Deletes a specified entry.

Input	Type	Description
`formId`required	id (picked from your account)	Form
`entryId`required	text	Enter the ID of the entry to delete.

get_entryin catalog

Get Entry. Gets a specified entry.

Input	Type	Description
`formId`required	id (picked from your account)	Form
`entryId`required	text	Enter the ID of the entry to retrieve.

update_entryin catalog

Update Entry. Update an existing entry.

Input	Type	Description
`formId`required	id (picked from your account)	Form
`entryId`required	text	Enter the ID of the entry you want to update.
`entryData`required	object (depends on other props)	Fields

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: cognito-forms
Category: Other
Tags: forms, entries, data-collection, payments
Package: @activepieces/piece-cognito-forms@0.1.4
Tier: Community