Run webhook

veryfront__run_webhook

Access

No external-service connection is required. Use a Veryfront credential with access to the requested resources.

Call type: Can change resources.

Arguments

FieldTypeRequiredDescription and constraints
project_referencestringNoProject ID or slug.
webhook_idstringYesThe webhook id. Task and workflow targets accept a project-execution credential that carries native source authority from project.runs.write instead of project.agents.write. Agent targets require project.agents.write, plus project.conversations.write for conversation-backed targets. Format: uuid.
payloadvalueNoPayload as an external sender would post it, any JSON value, at most 64 KiB. Defaults to {}.

Example request

Send this JSON-RPC request through an initialized MCP client. Replace sample identifiers and values before calling the tool. See MCP client setup.

json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "veryfront__run_webhook",
    "arguments": {
      "webhook_id": "00000000-0000-4000-8000-000000000000"
    }
  }
}

Result

The published output shape is summarized below. Inspect both the MCP response content and isError when handling a call.

FieldTypeRequiredDescription and constraints
idstringYesThe webhook event id. Every stored event has one, including events filtered before execution; pass it as webhook_event_id to replayWebhookEvent. Format: uuid.
webhook_idstringYesThe id of the webhook that received the event. Format: uuid.
project_idstringYesProject identifier associated with the record. Format: uuid.
conversation_idstring or nullYesConversation identifier associated with the record.
message_idstring or nullYesThe message id associated with this record.
run_idstring or nullYesAssociated execution, or null when the event started none.
canonical_run_idstring or nullYesThe canonical run id associated with this record.
latest_event_idinteger or nullYesThe latest event id associated with this record.
statusstringYesLifecycle status for the record. Values: "received", "queued", "running", "completed", "failed", "cancelled"; see schema for the complete list.
duplicatebooleanYesWhether the record represents a duplicate.
payloadvalueNoThe payload associated with this record.
error_codestring or nullYesThe error code associated with this record.
error_messagestring or nullYesThe error message associated with this record.
invoked_bystring or nullYesThe invoked by associated with this record.
manual_invoked_by_user_idstring or nullYesThe manual invoked by user id associated with this record.
received_atstring or nullYesThe received at associated with this record.
completed_atstring or nullYesThe completed at associated with this record.

Full schemas

json
{
  "type": "object",
  "properties": {
    "project_reference": {
      "type": "string",
      "description": "Project ID or slug."
    },
    "webhook_id": {
      "type": "string",
      "format": "uuid",
      "description": "The webhook id. Task and workflow targets accept a project-execution credential that carries native source authority from project.runs.write instead of project.agents.write. Agent targets require project.agents.write, plus project.conversations.write for conversation-backed targets."
    },
    "payload": {
      "description": "Payload as an external sender would post it, any JSON value, at most 64 KiB. Defaults to {}."
    }
  },
  "required": [
    "webhook_id"
  ],
  "additionalProperties": false,
  "description": "Structured run webhook by id input schema for MCP tools.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}
json
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "The webhook event id. Every stored event has one, including events filtered before execution; pass it as webhook_event_id to replayWebhookEvent."
    },
    "webhook_id": {
      "type": "string",
      "format": "uuid",
      "description": "The id of the webhook that received the event."
    },
    "project_id": {
      "type": "string",
      "format": "uuid",
      "description": "Project identifier associated with the record."
    },
    "conversation_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid",
          "description": "Conversation identifier associated with the record."
        },
        {
          "type": "null",
          "description": "Conversation identifier associated with this result."
        }
      ],
      "description": "Conversation identifier associated with the record."
    },
    "message_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid",
          "description": "The message id associated with this record."
        },
        {
          "type": "null",
          "description": "The message id returned by the tool."
        }
      ],
      "description": "The message id associated with this record."
    },
    "run_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "Associated execution, or null when the event started none."
    },
    "canonical_run_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid",
          "description": "The canonical run id associated with this record."
        },
        {
          "type": "null",
          "description": "The canonical run id returned by the tool."
        }
      ],
      "description": "The canonical run id associated with this record."
    },
    "latest_event_id": {
      "anyOf": [
        {
          "type": "integer",
          "minimum": 0,
          "description": "The latest event id associated with this record."
        },
        {
          "type": "null",
          "description": "The latest event id returned by the tool."
        }
      ],
      "description": "The latest event id associated with this record."
    },
    "status": {
      "type": "string",
      "enum": [
        "received",
        "queued",
        "running",
        "completed",
        "failed",
        "cancelled",
        "ignored"
      ],
      "description": "Lifecycle status for the record."
    },
    "duplicate": {
      "type": "boolean",
      "description": "Whether the record represents a duplicate."
    },
    "payload": {
      "description": "The payload associated with this record."
    },
    "error_code": {
      "type": [
        "string",
        "null"
      ],
      "description": "The error code associated with this record."
    },
    "error_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "The error message associated with this record."
    },
    "invoked_by": {
      "type": [
        "string",
        "null"
      ],
      "description": "The invoked by associated with this record."
    },
    "manual_invoked_by_user_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid",
          "description": "The manual invoked by user id associated with this record."
        },
        {
          "type": "null",
          "description": "The manual invoked by user id returned by the tool."
        }
      ],
      "description": "The manual invoked by user id associated with this record."
    },
    "received_at": {
      "type": [
        "string",
        "null"
      ],
      "description": "The received at associated with this record."
    },
    "completed_at": {
      "type": [
        "string",
        "null"
      ],
      "description": "The completed at associated with this record."
    }
  },
  "required": [
    "id",
    "webhook_id",
    "project_id",
    "conversation_id",
    "message_id",
    "run_id",
    "canonical_run_id",
    "latest_event_id",
    "status",
    "duplicate",
    "error_code",
    "error_message",
    "invoked_by",
    "manual_invoked_by_user_id",
    "received_at",
    "completed_at"
  ],
  "additionalProperties": false,
  "description": "The webhook event the call created.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}