WP Webhooks / Docs / get_trigger_schema
AI Ability since v2.0.0

get_trigger_schema

Get captured payload + mapping for a trigger — Return the last captured example payload, field mapping and conditions for a trigger (one webhook's, or the latest from any webhook) so the agent can map against the real payload shape.

$

Return the last captured example payload, field mapping and conditions for a trigger so the agent can map against the real payload shape. Pass webhook_id to read that webhook's own capture; omit it to get the latest example for the trigger from any webhook. If the capture is stale or opaque (no mappable fields), the result carries a capture_warning. When this site has no capture of its own, the reply can still carry an example from the hosted Payload Library — in which case it also sets example_source: "library", captured_from (the plugin build the payload came off), confidence, library_caveat, must_verify, and site_defined_paths, the paths under a container this site defines that set_mapping and set_conditions will refuse. Registered as the WordPress Ability flowsystems-webhook-actions/get-trigger-schema, so external AI tools (Claude Code, Cursor) can call it over MCP, or over the Abilities REST route with a scoped API token.

/ Plan step shape

{ "ability": "get_trigger_schema", "input": { "webhook_id": …, "trigger": … } }

/ Scope & confirmation

Minimum API-token scope for external (MCP/REST) callers: read. Read-only — the agent runs it freely while planning and verifying.

/ Input fields

NameInTypeReqDescription
webhook_idparaminteger—Optional — omit for a trigger-wide lookup.
triggerparamstringyes

/ Examples

Plan step as Build with AI proposes it

{
  "id": "step_1",
  "ability": "get_trigger_schema",
  "summary": "…",
  "input": {
    "webhook_id": 12,
    "trigger": "wpcf7_mail_sent"
  }
}

/ Related

Ready

Your next automation is
one sentence away.

$ wp plugin install flowsystems-webhook-actions --activate