Skip to content
Relay Port

Get started

Sandbox

Test keys and sandbox accounts run the whole publishing flow, including failures and unconfirmed targets, without touching a real network.

The sandbox is a test platform that publishes nowhere. With an rp_test_ key you can connect sandbox accounts, create posts, receive webhooks and read receipts exactly as you would for a real network, and choose how each post ends.

Connect a sandbox account

With a test key, POST /accounts/connect with platform set to sandbox creates an active account at once: there is no sign-in page. Test keys connect only test platforms. Real accounts are connected from the Dashboard or with a connect link.

Choose the outcome

A sandbox post settles at once, as its platformData.sandbox asks:

outcome What the target becomes
published published, with a platform post id and a permalink
failed failed, with the error code you give in failureCode
unconfirmed unconfirmed, as when a real platform does not confirm a publish

Use failed and unconfirmed to test the paths your integration must handle: a retry after a failure, and settling an unconfirmed target by hand.

What stays separate

  • Test keys see only test accounts and their posts, and live keys never see them.
  • Events from test posts carry livemode: false, so one webhook handler can tell them apart.
  • Sandbox posts follow the same rules as real ones: validation, idempotency keys and the duplicate guard all apply.