Skip to content
EntryWick documentation

For a developer who has never seen EntryWick and wants to connect a system to an organization that uses it.

Developer docs and the sandbox — entrywick.io/developers

Who uses it: a developer who has never seen EntryWick and wants to connect a system to an organization that uses it.

What they came to do: understand what the API can do, try a call without a real organization's data, and copy a working request.

True when they leave: they have made a real call against the sandbox and know which key, scope and plan their own integration needs.

What is there

  • /developers — getting a key, the base URL, the limits, the webhook signature vectors, and the sandbox's current test key.
  • /developers/reference — every operation in docs/API_V1.yaml, rendered by Scalar. "Try it" sends to the sandbox with its key filled in.
  • /developers/quickstarts — curl, JavaScript, PHP and Python for the three calls most integrations start with: register people, keep a list in step with updated_since, record a scan.
  • /developers/sandbox (week 23) — the published key and what is in the sandbox right now: the event's own id, its day, type and check-in point codes, a real ticket and registration reference, and a curl with all of it already substituted. Read live from the sandbox organization, so it cannot describe one that was refreshed underneath it.
  • /developers/changelog (week 23) — the API's own changelog, taken out of CHANGELOG.md by scope (api, webhooks, scanner, integrations, zapier, make, event templates), so a release cannot ship a change the portal does not mention. It also states what counts as a breaking change in v1.
  • /developers/status (week 23) — whether the app, the database, the cache, the background work, the certificates and the backups are healthy, from App\Support\Health\SystemStatus — the same implementation the public status page reads.
  • /developers/search (week 23) — every operation in docs/api/operations.json and every page here, searched on the server by path, scope, entitlement or word. No JavaScript.
  • /developers/scan-cases.json (week 23) — the golden check-in cases, as the file both EntryWick's own tests and the scanner's are held to. Run your hardware through them: result codes must match, the words you show a person are yours.
  • /developers/postman.json — the Postman collection, generated from the spec with every release.
  • /developers/openapi.yaml — the spec itself, as served.

The sandbox

php artisan ew:sandbox-tenant (nightly on staging and production) keeps a tenant called sandbox on the Scale plan: it archives yesterday's event, imports a fresh Community Celebration, registers a few dozen invented people and rotates a published ewk_test_ key with read, write and scanner scopes. Nothing in it is real, and a test key's check-ins are kept out of everything live.

For the organizer's own integrations

Keys, scopes and limits: api-keys.md. Scanning with a key: scanner-api.md.