Replay the events of a time window to a Webhook subscription

POST /v1/webhooks/{webhook_id}/replay

Creates a webhook.replay job (1.52.0, ADR 0051 rule 6) that re-sends, in sequence order, every event of the 30-day log created in [from, to) that the subscription matches now, narrowed by types; each delivery keeps its event id and carries Vocal-Replay: true, and no effect inside Vocal runs again. Answers 202 with the job and its Location. The window is checked first (ReplayWindowIssueCode): replay_window_inverted, replay_window_out_of_range and, past 10,000 matching events (a target), replay_window_too_large. A second replay while one is queued or running is 409 replay_in_progress. The Audit event webhooks.replay records the subscription, the window and the types. The subscription is a resource of slice 2.5: until it exists every webhook_id is not_found, and slice 2.5 adds the event_id form of the body. From 1.63.0 the subscriptions exist (create_webhook), the body may instead name one event_id, a job of that one event that re-sends it under its own id, at most ten times per event and subscription (WebhookReplayEventIssueCode), and a subscription that is not active is refused with 409 webhook_not_active.

Request

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

curl -X POST "$VOCAL_API/v1/webhooks/whk_.../replay" \
  -H "Authorization: Bearer $VOCAL_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{ "from": "2026-10-07T14:02:11.408Z", "to": "2026-10-07T14:02:11.408Z" }'

const response = await fetch(`${process.env.VOCAL_API}/v1/webhooks/whk_.../replay`, {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
    'Idempotency-Key': crypto.randomUUID(),
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "from": "2026-10-07T14:02:11.408Z",
    "to": "2026-10-07T14:02:11.408Z"
  }),
});
console.log(response.status, await response.text());

import os
import uuid

import requests

response = requests.post(
    f"{os.environ['VOCAL_API']}/v1/webhooks/whk_.../replay",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "from": "2026-10-07T14:02:11.408Z",
        "to": "2026-10-07T14:02:11.408Z",
    },
)
print(response.status_code, response.text)

Parameters

Request body

Content type application/json, required: WebhookReplayRequest.

Responses

Fields of the 202 answer

The shape is Job.