Building a webhook integration? Read the webhook guide for signatures, retries, event schemas, and troubleshooting.

apiDeterministic

Apply table playbook

POST /api/v1/tables/playbooks/apply

Apply one implemented playbook as a typed parent and child column family. Validates mappings and workspace BYOK but never executes rows.

Parameters

workspaceId

string

Optional with API key auth, inferred from the key.

tableIdrequired

string

No description.

playbookIdrequired

string

Playbook ID returned by list-table-playbooks

pricing-plans | new-in-role

inputMappingsrequired

object

Playbook input key to existing Table column ID.

executionModerequired

string

No description.

pipeline_hosted | external_agent

llmCredentialId

string

No description.

searchCredentialId

string

No description.

providerCredentialId

string

No description.

allowDuplicate

boolean

No description.

allowHostedAi

boolean

Required for API, MCP, CLI, and SDK callers that explicitly choose pipeline_hosted execution.

Example

REST requestbash

curl -X POST "https://app.pipeline.help/api/v1/tables/playbooks/apply" \
  -H "Authorization: Bearer $PIPELINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"tableId":"00000000-0000-4000-8000-000000000000","playbookId":"pricing-plans","inputMappings":{},"executionMode":"pipeline_hosted"}'

Response

Success response schemajson schema

{
  "type": "object",
  "properties": {
    "playbookId": {
      "type": "string"
    },
    "executionMode": {
      "type": "string"
    },
    "parentColumnId": {
      "type": "string"
    },
    "childColumnIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "addedColumnIds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "resolvedInputMappings": {
      "type": "object"
    }
  },
  "required": [
    "playbookId",
    "executionMode",
    "parentColumnId",
    "childColumnIds",
    "addedColumnIds",
    "resolvedInputMappings"
  ]
}

HTTP errors

401: Missing or invalid API key.
403: Authenticated but not permitted for the workspace or resource.
404: The requested resource was not found.