API keys and webhooks

Available on Pro. The API is how Field Wizard talks to whatever else you run.

Creating a key

Settings → API. Create a key, name it for the thing that will use it, and copy it — the key is shown once and stored hashed, so if you lose it you issue a new one rather than recovering the old one.

Revoke a key from the same screen. Revocation is immediate.

What you can reach

Submissions and customer records, over a versioned REST API. The reference is published for signed-in users at /api/reference, generated from the API itself rather than written by hand, so it cannot describe endpoints that do not exist.

Webhooks

Rather than polling us, have us call you. Register a URL and choose the events — a submission arriving, an account being created or updated.

Every webhook is signed with an HMAC signature so your endpoint can verify the request genuinely came from us. Verify it; an unauthenticated endpoint that accepts anything shaped like our payload is a hole.

Deliveries retry on failure.

Rate limits

Keys are rate limited. If you are pulling large volumes on a schedule, page through rather than requesting everything at once.