Replay a Trigger event's action

POST /v1/trigger-events/{trigger_event_id}/replay

Property	Value
Operation	`replay_trigger_event`
Group	Triggers
Scope	`integrations:write`
Route class	`control`
Idempotency	`Idempotency-Key` required: a retry with the same key replays the first answer
Audit	Audited `integrations.trigger_event.replay` (mutation)
Released in	1.60.0
Phase 0 host	Served (the hosted api pins 1.65.0)

Queues a trigger_event.replay job that runs the event's action again under its original id, and answers 202 with it and its Location (1.60.0; integrations-operations.md section 3). A replayed start_call returns the existing Call unless force is set, which needs an owner or admin (forbidden, owner_or_admin_required). A filtered event has no action to replay (validation_failed, trigger_event_not_replayable). Every replay writes an Audit event.

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the integrations:write scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl -X POST "$VOCAL_API/v1/trigger-events/tev_.../replay" \
  -H "Authorization: Bearer $VOCAL_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'

const response = await fetch(`${process.env.VOCAL_API}/v1/trigger-events/tev_.../replay`, {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
    'Idempotency-Key': crypto.randomUUID(),
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
});
console.log(response.status, await response.text());

import os
import uuid

import requests

response = requests.post(
    f"{os.environ['VOCAL_API']}/v1/trigger-events/tev_.../replay",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={},
)
print(response.status_code, response.text)

Parameters

Name	In	Type	Required	Description
`trigger_event_id`	path	TriggerEventId	yes	The id of a Trigger event: `tev_` and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log.
`idempotency-key`	header	string	yes	A client-chosen key, kept 24 hours per Organization, environment and route. A replay returns the stored response.

Request body

Content type application/json, required: TriggerEventReplayRequest.

Field	Type	Required	Description
`force`	boolean	no	Starts a new Call where the replayed `start_call` would return the existing one; an `owner` or `admin` only (`owner_or_admin_required`). False when omitted.

Responses

Status	Content type	Shape	Error codes
`202`	`application/json`	Job
`400`	`application/json`	ErrorEnvelope	`invalid_request`
`401`	`application/json`	ErrorEnvelope	`unauthenticated`
`403`	`application/json`	ErrorEnvelope	`forbidden`, `org_suspended`
`404`	`application/json`	ErrorEnvelope	`not_found`
`409`	`application/json`	ErrorEnvelope	`idempotency_in_progress`, `idempotency_key_reused`
`422`	`application/json`	ErrorEnvelope	`validation_failed`
`429`	`application/json`	ErrorEnvelope	`rate_limited`
`500`	`application/json`	ErrorEnvelope	`internal_error`

Fields of the `202` answer

The shape is Job.

Field	Type	Required	Description
`created_at`	Timestamp	yes
`created_by`	ActorRef	yes
`error`	JobError or null	yes	Why the job `failed`, a code and a message; null otherwise.
`finished_at`	Timestamp or null	yes
`has_result_file`	boolean	yes	True when the result is a file, fetched through POST `/v1/jobs/{job_id}/result-url`.
`id`	JobId	yes
`object`	`"job"`	yes
`progress`	JobProgress	yes
`resource`	JobResource or null	yes
`result`	JobResult or null	yes	A small result inline once `succeeded`, typed by the job type (`WebhookReplayJobResult` for `webhook.replay`, from 1.53.0 `KnowledgeEvaluationJobResult` for `knowledge.evaluation`, from 1.55.0 `PromptEvalRunJobResult` for `prompt.evaluation` and `agent.conversation_test`, from 1.56.0 `AnalysisJobResult` for `call.analyze`); null before.
`started_at`	Timestamp or null	yes
`status`	JobStatus	yes
`type`	JobType	yes