Skip to content
FolioSign inStart your trial

Docs · Start here

Sandbox and testing

Get a free sandbox church and test keys, know its limits, and test webhooks without touching real data.

A sandbox church is a free church for development. It is not metered, has no subscription and sends no email. Keys issued for it start with folio_test_, and the API refuses to mix modes: a test key can never reach a live church and a live key can never reach a sandbox church.

Get one#

Sandbox churches are created by partners. With a partner key:

curl -X POST "$FOLIO_API_URL/v1/partner/churches" \
  -H "Authorization: Bearer $FOLIO_PARTNER_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: sandbox-dev-1" \
  -d '{
  "name": "Acme sandbox",
  "admin_email": "[email protected]",
  "sandbox": true
}'

Then issue a test key for it:

curl -X POST "$FOLIO_API_URL/v1/partner/churches/org_0192f7a8-3b1c-7d2e-9a40-5c6d7e8f9012/keys" \
  -H "Authorization: Bearer $FOLIO_PARTNER_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "dev",
  "scopes": [
    "machine:*"
  ]
}'

The response holds a folio_test_… key, shown once. Use it exactly like a church key. If you are not a partner yet, ask us for a sandbox.

Limits#

  • At most 20 teachings per sandbox church.
  • A small AI budget, enforced on Ask and uploads. When it is used up you get 402 ai_budget_exhausted; create a new sandbox church to keep testing.
  • At most 25 sandbox churches per partner.
  • It is deleted after 30 days. expires_at on the church says when.
  • Switched off: live captions, the booth, audience email and campaigns, publishing, networks, care, SSO, the widget, exports and outbound webhooks.

There are no fake transcription or AI providers. Calls use the real ones under the caps above, so keep test recordings short. Everything else (listing, keys, metadata) is free.

Testing webhooks#

Outbound webhooks are off in a sandbox church. Test your receiver with a live church's endpoint and POST /v1/webhook-endpoints/{endpoint}/test, which sends a signed test event (marked Folio-Test: true), or replay a real delivery. Your verification code is the same either way; see webhooks.

The reference "Try it"#

The API reference can send requests from your browser to the sandbox. Paste a folio_test_ key into the box; it stays in your browser's memory, is never stored, and never goes to this website.

Verified against API version 0.0.0-dev. Generated from the live OpenAPI document.