Skip to content

docs: add outbound file delivery guide - #143

Merged
karlrank merged 6 commits into
mainfrom
docs/integration-toolkit-outbound-file-delivery
Aug 21, 2026
Merged

docs: add outbound file delivery guide#143
karlrank merged 6 commits into
mainfrom
docs/integration-toolkit-outbound-file-delivery

Conversation

@karlrank

Copy link
Copy Markdown
Member

Summary

  • add the public Integration Toolkit outbound file delivery guide
  • document the CustomerRequestSubmitted setup, fan-out, JSONata and Handlebars contexts, retries, and monitoring codes
  • expose CustomerRequestSubmitted in the Core Events viewer with generated schema assets
  • update Integration Toolkit overview, configuration, file-proxy navigation, and sidebar ordering

Validation

  • Docusaurus production build
  • JSON request examples parsed successfully
  • CustomerRequestSubmitted assets match Event Catalog snapshots
  • git diff whitespace checks

Related

@karlrank

Copy link
Copy Markdown
Member Author

@karlrank

Copy link
Copy Markdown
Member Author

Karl Rankla added 2 commits August 21, 2026 13:00
One binding for files: $file_data, always an array — the delivery's single
attachment when fanning out, every attachment when not. Replaces $item,
$file and $file_base64, and the {{ item.* }} / {{ file.* }} Handlebars
equivalents.

Removes the fields the API now rejects at save time, each naming its
replacement: fan_out.split_expression, file_source, shared, required_keys,
params_mapping, required_params, constants, lookups, upload.success_when
and upload.external_id. A 2xx from the last step is the delivery, so there
is no separate predicate re-judging it and no external id correlation hint
to promise.

Documents the per-step enabled expression and the skipped outcome it
produces, upload.max_total_bytes, the JSONata body (body_jsonata, or empty
to send the files unchanged), single-pass Handlebars for url and headers
with plain {{env.NAME}}, and the save-time rule that an upload may only be
bound to an event declaring event_attachments.

Every example is verified against the shipped contract: each JSONata
expression evaluates and passes the save-time binding check, and each
Handlebars path resolves against the delivery's template context.
@karlrank
karlrank merged commit b32a5b1 into main Aug 21, 2026
1 check passed
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