Skip to Content

Replay received documents to an endpoint

POST
/v1/webhook-endpoints/{id}/backfill

Replays every received document of the endpoint's business and environment issued since since, oldest first, as received_document.created events, each delivery's payload saying backfill: true. Each event keeps the id derived from its access key, so a receiver that deduplicates by webhook-id sees a document delivered live and again by a backfill as one event. It runs in the background, one per endpoint at a time; the endpoint's backfill shows its progress. Answers 202 with the backfill.

Authorization

headerAuthorizationBearer <token>

Your API key, which acts for the one business it was created for: fb_live_… keys work at api.fiscalbase.io and issue in live, and fb_sandbox_… keys work at api-sandbox.fiscalbase.io and issue in sandbox, on the simulated SRI. A key sent to the other host is refused with api_key_wrong_host, which names its host.

Path Parameters

id*string
Formatuuid

Header Parameters

idempotency-key?string

Send the same key to retry safely: a repeat of the same request answers what the first answered, without doing it again. Keys are scoped to your key's business and environment; the same key with another request is 409 idempotency_key_reused.

Length1 <= length <= 255
Fiscalbase-Environment?string

The environment the call acts in. Required with a person's session; a key's own environment is the one that counts, so a key may leave it out, and naming another is 422 environment_mismatch.

Value in"sandbox""test""live"
Fiscalbase-Business?string

The business the call acts for. With a person's session, the one the call is about (without it, a call about one business is 422 business_required and a list covers every business of the organization); a key acts for its own, so naming another is 422 business_mismatch.

Formatuuid
Fiscalbase-Channel?string

Which of Fiscalbase's own integrations a key's call comes from, recorded as the channel of the documents it issues: a record, not a permission. Without it, api. A person's call is always console.

Value in"api""mcp"
Fiscalbase-Agent?string

The AI agent a key's call comes from, as its client names itself (the MCP server sets it); recorded with the request and shown in the console's request log.

Request Body

application/json
  1. body
since*string

Replay the documents issued on or after this day (Ecuador's calendar), up to today.

Formatdate

Response Body

Started

application/json
  1. response
id*string
Formatuuid
object*"webhook_backfill"
Value in"webhook_backfill"
status*string
Value in"running""completed""failed"
since*string

Documents issued on or after this day are replayed.

Formatdate
event_count*integer

How many events it replays, counted when it started.

queued*integer

How many of them it has queued so far; each is then delivered with the usual retries.

created_at*string
Formatdate-time
finished_at*|
Formatdate-time
Example Request
curl -X POST 'https://api.fiscalbase.io/v1/webhook-endpoints/497f6eca-6276-4993-bfeb-53cbbbba6f08/backfill' \
  -H 'Content-Type: application/json' \
  -d '{
  "since": "2019-08-24"
}'
Example Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "object": "webhook_backfill",
  "status": "running",
  "since": "2019-08-24",
  "event_count": 0,
  "queued": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "finished_at": "2019-08-24T14:15:22Z"
}