Skip to main content

Integration patterns

The endpoint reference describes what each endpoint accepts. These pages cover the how — the cross-cutting patterns and gotchas we’ve seen customers hit when building against Upwell.

Money & payloads

Integer-cents money, the input/inputs wrappers, and the auth header.

Idempotency & retries

Your external key, per-resource POST duplicate semantics, and required fields with no defaults.

Documents

The presigned upload flow, the sourceSystem pair rule, and rate-confirmation typing.

Addresses

The full address playbook — link direction, types, visibility, and the one-billing-address rule.

Deletes & archiving

Hard vs. soft delete per resource, and external-key reuse.

Rules

The three rule shapes and a worked DSL example.