Actions

An action is what a decision turns into: allow, reject, a change of author status, or an operation you define in the dashboard. Every execution is logged and emits the action.executed webhook event.

Endpoints

The action object

An operation that can be executed on a moderation or on an author. Every project has five built-in actions; others are defined in the dashboard.

The action objectJSON

{
  "object": "action",
  "id": "act_2BdP4rjezzQ5PTND66nyLi",
  "project_id": "prj_0TBAgHGtdMketrbltGFHuk",
  "key": "request_edits",
  "name": "Request edits",
  "description": "Send the content back to its author with what to change. Your webhook receives the message.",
  "target": "content",
  "queue_behavior": "resolve",
  "visible_in_dashboard": true,
  "accepts_value": true,
  "value_schema": null,
  "built_in": false,
  "enabled": true,
  "position": 5,
  "created_at": "2026-10-08T08:44:38.841Z",
  "updated_at": "2026-10-08T08:44:38.841Z"
}

Attributes

object"action"

Always action.

idstring

Id of the action: act_ plus 22 base62 characters. API paths use key instead.

keystring

The name used in POST /v1/actions/{key}/execute and in a queue item's resolution, in snake_case. Unique in the project.

namestring

Display name.

targetenum

content: executed on a moderation. author: executed on an author.

One ofcontentauthor

queue_behaviorenum

What an execution does to the moderation's review queue item: resolve it, keep it as it is, or reopen it.

One ofresolvekeepreopen

accepts_valueboolean

Whether an execution may carry a value.

built_inboolean

True for allow, reject, block_author, suspend_author and enable_author, which every project has and which cannot be deleted.

enabledboolean

False for an action that is switched off and refuses to execute. GET /v1/actions lists enabled actions only, so it is always true there.

project_idstring

Id of the project: prj_ plus 22 base62 characters.

descriptionstring

What the action is for, or null.

visible_in_dashboardboolean

Whether the action is offered to reviewers in the dashboard.

value_schema

A description of the expected value, or null. It is stored for your reference and not enforced.

positioninteger

Place of the action in lists, an integer from 0.

created_attimestamp

When the action was created, ISO 8601 in UTC.

updated_attimestamp

When the action last changed, ISO 8601 in UTC.

Something missing or unclear on this page? Write to support@useinfrared.com.