Skip to main content

Documentation Index

Fetch the complete documentation index at: https://veryfront.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Use Automation when work needs to start, run, schedule, retry, or respond to an external webhook.

​
What belongs here

  • Tasks define deterministic project operations.
  • Workflows orchestrate repeatable multi-step automation.
  • Jobs are durable executions of a concrete target.
  • Webhooks are HTTP ingress points that turn an external event into a durable Veryfront run.

​
Webhooks

A webhook is a project resource with a stable public ingress URL and one explicit target. The REST contract exposes normal CRUD plus two invocation paths:
OperationEndpointPurpose
ListGET /{project_reference}/webhooksList project webhooks.
CreatePOST /{project_reference}/webhooksCreate an enabled webhook and return its secret once.
GetGET /{project_reference}/webhooks/{webhook_definition_id}Read one webhook definition.
UpdatePATCH /{project_reference}/webhooks/{webhook_definition_id}Rename, retarget, edit the prompt template, or enable/disable.
DeleteDELETE /{project_reference}/webhooks/{webhook_definition_id}Delete the definition and stop future deliveries.
Authenticated runPOST /{project_reference}/webhooks/{webhook_definition_id}/runManually invoke the webhook with an authenticated user token.
Public ingressPOST /webhooks/{webhook_id}Receive an external delivery with X-Veryfront-Webhook-Secret and Idempotency-Key.
Webhook definitions use a normalized target shape: 
{
  "name": "Incoming deployment webhook",
  "target": { "kind": "agent", "id": "inbox-assistant" },
  "prompt_template": "Summarize {{payload.action}} for the team."
}
target.kind can be:
KindEffect
agentCreates a conversation message from the webhook sender and queues an agent run.
jobQueues a project-owned job run with the delivery payload in the job config.
workflowQueues a project-owned workflow run with the delivery payload in the workflow input.
The webhook event keeps the durable links returned by the run path: webhook_event_id, run_id, canonical_run_id, and, for agent targets, conversation_id and message_id.

​
API surfaces

SurfaceWhere to start
RESTTasks, Workflows, Jobs, Webhooks
GraphQLTask, workflow, and job views
MCPJob and automation tools
The generated REST reference is sourced from https://api.veryfront.com/openapi.json; webhook CRUD and target schemas appear there after the API deployment containing this contract is live.