POST /projects/{project_reference}/webhooks/{webhook_id}/events/{webhook_event_id}/replaySend the stored payload of a webhook event to the current target of the webhook again, for example after a failed run; returns the new webhook event that the replay created.
Servers
[
{
"url": "https://api.veryfront.com"
}
]Authentication
[
{
"bearerAuth": []
},
{
"apiKeyAuth": []
}
]{
"bearerAuth": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT or API Key",
"description": "Use a JWT bearer token or a Veryfront API key in the `Authorization` header."
},
"apiKeyAuth": {
"type": "apiKey",
"in": "header",
"name": "X-API-Key",
"description": "Alternative API key header for `vf_<prefix>_<secret>` tokens."
}
}Parameters
Parameter contracts
[
{
"schema": {
"type": "string",
"minLength": 1
},
"required": true,
"name": "project_reference",
"in": "path"
},
{
"schema": {
"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."
},
"required": true,
"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.",
"name": "webhook_id",
"in": "path"
},
{
"schema": {
"type": "string",
"format": "uuid",
"description": "Stored delivery to replay: a new webhook event is created from its payload and run through the webhook target. 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."
},
"required": true,
"description": "Stored delivery to replay: a new webhook event is created from its payload and run through the webhook target. 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.",
"name": "webhook_event_id",
"in": "path"
}
]Responses
202
Replay accepted: a new webhook event created from the stored payload and run through the webhook target.
{
"description": "Replay accepted: a new webhook event created from the stored payload and run through the webhook target.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebhookRun"
}
}
}
}400
invalid_input: invalid body or parameters
{
"description": "invalid_input: invalid body or parameters",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}401
unauthenticated
{
"description": "unauthenticated",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}403
forbidden: a project member without the required capability
{
"description": "forbidden: a project member without the required capability",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}404
not_found: project or webhook not found or not visible
{
"description": "not_found: project or webhook not found or not visible",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}412
conflict: project automation is on hold
{
"description": "conflict: project automation is on hold",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}500
internal
{
"description": "internal",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}503
internal: authentication state is temporarily unavailable, or run admission is fenced and no run was admitted; retry shortly, after the Retry-After delay when one is sent
{
"description": "internal: authentication state is temporarily unavailable, or run admission is fenced and no run was admitted; retry shortly, after the Retry-After delay when one is sent",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}Referenced contracts
components/schemas/WebhookRun
{
"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"
},
"conversation_id": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"message_id": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"run_id": {
"type": [
"string",
"null"
],
"description": "Associated execution, or null when the event started none."
},
"canonical_run_id": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"latest_event_id": {
"type": [
"integer",
"null"
],
"minimum": 0
},
"status": {
"type": "string",
"enum": [
"received",
"queued",
"running",
"completed",
"failed",
"cancelled",
"ignored"
],
"description": "Webhook event status: received, queued, running, completed, failed, cancelled or ignored. A linked agent run overlays running (also while it waits for a tool), completed, failed or cancelled."
},
"duplicate": {
"type": "boolean"
},
"payload": {},
"error_code": {
"type": [
"string",
"null"
]
},
"error_message": {
"type": [
"string",
"null"
]
},
"invoked_by": {
"type": [
"string",
"null"
]
},
"manual_invoked_by_user_id": {
"type": [
"string",
"null"
],
"format": "uuid"
},
"received_at": {
"type": [
"string",
"null"
]
},
"completed_at": {
"type": [
"string",
"null"
]
}
},
"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"
]
}components/schemas/Problem
{
"type": "object",
"properties": {
"cause": {
"type": "string",
"enum": [
"schedule_concurrency_forbidden",
"schedule_fire_in_progress",
"schedule_run_limit_reached"
],
"description": "Schedule admission refusal."
},
"idempotency": {
"type": "object",
"properties": {
"state": {
"type": "string",
"enum": [
"in_progress",
"payload_mismatch",
"outcome_unknown"
]
},
"operation": {
"type": "string",
"minLength": 1
},
"retryable": {
"type": "boolean"
},
"retry_after_seconds": {
"type": [
"integer",
"null"
],
"minimum": 0
},
"expires_at": {
"type": [
"string",
"null"
]
},
"recovery": {
"type": "object",
"properties": {
"available": {
"type": "boolean"
},
"description": {
"type": "string"
},
"resource_url": {
"type": "string"
}
},
"required": [
"available",
"description"
]
}
},
"required": [
"state",
"operation",
"retryable",
"retry_after_seconds",
"expires_at"
],
"description": "Replay status, retry timing, and recovery lookup."
},
"type": {
"type": "string",
"description": "URI reference identifying the problem type",
"example": "https://api.veryfront.com/errors/validation-failed"
},
"title": {
"type": "string",
"description": "Short human-readable summary of the problem",
"example": "Validation Failed"
},
"status": {
"type": "integer",
"minimum": 100,
"maximum": 599,
"description": "HTTP status code",
"example": 400
},
"code": {
"type": "string",
"description": "Stable machine-readable error code",
"example": "RUN_INVALID_INPUT"
},
"detail": {
"type": "string",
"description": "Human-readable explanation specific to this occurrence",
"example": "The 'email' field must be a valid email address"
},
"instance": {
"type": "string",
"description": "URI reference identifying the specific occurrence",
"example": "/projects/my-project/members"
},
"slug": {
"type": "string",
"description": "Stable identifier for the problem type",
"example": "validation-failed"
},
"category": {
"type": "string",
"enum": [
"AUTH",
"RESOURCE",
"VALIDATION",
"DATABASE",
"SUBSCRIPTION",
"INTEGRATION",
"INTERNAL"
],
"description": "API error category",
"example": "VALIDATION"
},
"suggestion": {
"type": "string",
"description": "Suggested action to resolve the problem",
"example": "Check the request body and query parameters against the API documentation."
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "Field path that caused the error",
"example": "email"
},
"message": {
"type": "string",
"description": "Error message for this field",
"example": "Invalid email format"
},
"code": {
"type": "string",
"description": "Error code for this field",
"example": "INVALID_FORMAT"
}
},
"required": [
"field",
"message"
]
},
"description": "Detailed field-level errors for validation failures"
}
},
"required": [
"type",
"title",
"status"
]
}Operation contract
{
"operationId": "replayWebhookEvent",
"tags": [
"execution/Triggers/Webhook events"
],
"summary": "Replay webhook event",
"description": "Send the stored payload of a webhook event to the current target of the webhook again, for example after a failed run; returns the new webhook event that the replay created.",
"parameters": [
{
"schema": {
"type": "string",
"minLength": 1
},
"required": true,
"name": "project_reference",
"in": "path"
},
{
"schema": {
"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."
},
"required": true,
"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.",
"name": "webhook_id",
"in": "path"
},
{
"schema": {
"type": "string",
"format": "uuid",
"description": "Stored delivery to replay: a new webhook event is created from its payload and run through the webhook target. 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."
},
"required": true,
"description": "Stored delivery to replay: a new webhook event is created from its payload and run through the webhook target. 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.",
"name": "webhook_event_id",
"in": "path"
}
],
"responses": {
"202": {
"description": "Replay accepted: a new webhook event created from the stored payload and run through the webhook target.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebhookRun"
}
}
}
},
"400": {
"description": "invalid_input: invalid body or parameters",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
},
"401": {
"description": "unauthenticated",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
},
"403": {
"description": "forbidden: a project member without the required capability",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
},
"404": {
"description": "not_found: project or webhook not found or not visible",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
},
"412": {
"description": "conflict: project automation is on hold",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
},
"500": {
"description": "internal",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
},
"503": {
"description": "internal: authentication state is temporarily unavailable, or run admission is fenced and no run was admitted; retry shortly, after the Retry-After delay when one is sent",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
},
"x-documentation-source-tag": "Webhook events",
"x-canonical-documentation": {
"domain": "execution",
"resource": "Triggers",
"subgroup": "Webhook events",
"name": "Replay webhook event",
"description": "Send the stored payload of a webhook event to the current target of the webhook again, for example after a failed run; returns the new webhook event that the replay created.",
"operationId": "replayWebhookEvent"
},
"x-mint": {
"href": "/cloud/rest/api-reference/execution-triggers-webhook-events/replay-webhook-event"
}
}