webhooks.replay
Re-deliver a checkpoint range to a webhook.
Details
- Endpoint
- POST /v0/webhooks/:webhookID/replay
- Credits
- Free
- Rate class
- Light. Counts against your light requests per second.
Reads the range from the index, matches it with the webhook's current filter and queues the deliveries as a separate replay, so live deliveries are not touched. The range may span up to 200,000 checkpoints and must be inside your plan's replay depth (GET /v0/stream/replay-info). Replayed transactions cost 1 credit each like live ones.
Parameters
| Name | Type | Description |
|---|---|---|
| webhookIDrequired | string | The webhook id. |
| fromCheckpointrequired | integer | First checkpoint. |
| toCheckpointrequired | integer | Last checkpoint, inclusive. |
Request
Send your key in the x-api-key header, or leave it out to use the keyless tier.
curl
curl -X POST "https://api.tide.ad/v0/webhooks/00000000-0000-0000-0000-000000000000/replay" \
-H "x-api-key: YOUR_API_KEY" \
-H "content-type: application/json" \
-d '{
"fromCheckpoint": 341000000,
"toCheckpoint": 341000100
}'TypeScript
const res = await fetch("https://api.tide.ad/v0/webhooks/00000000-0000-0000-0000-000000000000/replay", {
method: "POST",
headers: {
"x-api-key": process.env.TIDE_API_KEY!,
"content-type": "application/json",
},
body: JSON.stringify({
"fromCheckpoint": 341000000,
"toCheckpoint": 341000100
}),
});
const data = await res.json();Response
No example response is available for this method yet.