Skip to content

docs(integration-toolkit): large data loads, the 503 for exhausted capacity, and sandbox organizations - #190

Draft
karlrank wants to merge 2 commits into
mainfrom
docs/bulk-loads-and-fair-processing
Draft

karlrank wants to merge 2 commits into
mainfrom
docs/bulk-loads-and-fair-processing

Conversation

@karlrank

Copy link
Copy Markdown
Member

Replaces #182.

  • New page Large Data Loads (/integrations/integration-toolkit/large-data-loads): how migrations, full resyncs and large file imports are recognized and processed, what an integrator notices, and the one new response a client has to handle (503 with Retry-After and BULK_CAPACITY_EXHAUSTED).
  • New page Sandbox Organizations (/integrations/integration-toolkit/sandbox-organizations), rewritten from docs(integration-toolkit): sandbox organizations and the SANDBOX_LANE monitoring code #182 for the new behaviour: everyday traffic is handled as in production, large loads in a sandbox share a small capacity and run at a low rate. The Integration Hub banner and the SANDBOX_LANE notice link to this address.
  • inbound/getting-started.md: a "When to Retry" table for 429 and 503.
  • interactive-inbound.md: 503 added where retries are described; interactive events do not count towards the allowance and are never refused for lack of capacity.
  • monitoring/investigating.md: a replay can also be answered with 503.
  • overview.md, configuration.md: cross-links.

monitoring/codes.md is generated and is not changed here.

Do not merge before the feature is live. The pages describe behaviour that is not deployed yet, and two details will still change before then: the wording of the BULK_CAPACITY_EXHAUSTED message in the examples, and how a waiting file import shows in the API.

Karl Rankla added 2 commits November 13, 2026 15:47
…pacity, and sandbox organizations

Adds a Large Data Loads page: how everyday traffic and large loads are
processed, what a large load looks like from outside, the 503 response with
Retry-After and BULK_CAPACITY_EXHAUSTED (whole and mixed requests), file
imports that wait for capacity, and planning a migration.

Adds the Sandbox Organizations page at the address the Integration Hub banner
and the SANDBOX_LANE notice link to, for the new sandbox behaviour.

Adds the 503 where retries are described (inbound getting started, interactive
inbound closing rules and rate limits, replay) and cross-links from the
overview and the configuration page.
… import

Quotes the reworded 503 messages: the one for a request refused whole, the
top-level message of a mixed request and the message on each refused event,
and the new message of an import that gave up waiting.

Shows a file import that waits for capacity through
progress.waiting_for_capacity (since, retry_at, gives_up_at), with an example
job, and drops the sentence that its progress simply does not advance.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant