Integrations

Create API keys for the partner API

Create an API key with the permissions your app needs, then make your first request.

On this page

API keys let an application you run call the Snapbar partner API for your account. Keys are account-scoped, not restricted to one activation; endpoint experience filters only restrict webhook delivery. Use separate accounts when vendors must not access each other’s activations. Each key carries only the access presets you choose, is shown once, and can be revoked at any time. You need integrations enabled and owner or admin access to create one.

Before you create a key

Testing a webhook? Choose Live with Manage notification endpoints. Signed tests send synthetic data to a registered receiver and create no Activity record. A Test key cannot register an endpoint or send a network test.
Exploring the API? Choose Test with Read submissions to list activation metadata, or Manage notification endpoints to fetch a synthetic sample. Test keys cannot read live guest records or upload photos.
An API activation is a Dashboard experience. Requests use its UUID id, not its exp_… short ID. Keep keys in your server’s secret store; never put them in browser code.

Create a key

Open Integrations > Developer and select Create API key.
Name the key after the application that will hold it, choose Live or Test, and pick the smallest set of access presets it needs. Each preset maps to one API scope.
Select Create key and copy the full value into your secret store right away. Snapbar keeps only a hash and cannot show the key again. Copying the key or confirming the acknowledgement enables Done.
When an application is retired or a key may have leaked, select Revoke on its row and confirm with Revoke key. Revocation takes effect immediately and cannot be undone. Create a replacement first if the application still needs access.

Authenticate a request

Send the key as a bearer token on every request. All routes live under https://integrations.snapbar.com/v1.

curl --fail-with-body \
  --header "Authorization: Bearer ${SNAPBAR_API_KEY}" \
  https://integrations.snapbar.com/v1/activations

A collection answers with data, next_cursor, and has_more. The activations page looks like this; the id is what endpoint registration and photo ingest take as the activation identifier.

{
  "data": [
    {
      "id": "2f5c1a8e-7d3b-4e1f-9a6c-0b8d4e2f1a37",
      "short_id": "exp_Abc123Def456",
      "name": "Summer Launch",
      "type": "ai_photo_booth",
      "state": "ACTIVE",
      "starts_at": "2026-07-18T16:00:00+00:00",
      "ends_at": "2026-07-18T23:00:00+00:00",
      "created_at": "2026-07-01T14:12:09.184+00:00"
    }
  ],
  "next_cursor": null,
  "has_more": false
}

Read X-Request-Id for correlation and inspect RateLimit-Limit, RateLimit-Remaining, and RateLimit-Reset when present; responses rejected before rate-limit evaluation may omit the rate-limit headers. You may send your own X-Request-Id of up to 128 characters and it is echoed back unchanged; longer values are replaced with one Snapbar mints. Quote the request id when you contact support about a call.

Access presets and what they unlock

A key can never grant more than its creator can see: presets that need a team permission the creator lacks are unavailable in the dialog, and the server refuses a key that would exceed the creator’s access.

Read submissions

read:submissions

List activations, list completed submissions with their finished media, and read one submission in any state.
Requires permission to view submissions.

Read lead details

leads:read

Adds contact details, custom fields, and consent data to submission reads with include_lead=true.
Requires permission to view submissions. Usable with live keys only.

Manage notification endpoints

manage:webhooks

Register, list, and delete signed webhook endpoints, fetch a sample envelope, and send test deliveries.
Requires permission to view submissions, because endpoints receive lead data.

Operations (replay)

operations

List deliveries and replay eligible ones.
No extra team permission beyond managing integrations.

Moderate submissions

moderate:submissions

Hide or restore submission media from your own tools.
Requires submission moderation permission.

Create submissions

write:submissions

Send photos into an activation as finished uploads or for AI processing. Each accepted request spends one credit.
Requires activation management permission.

What to know

Test keys never touch live guest data.A sbk_test_ key can list activation metadata with Read submissions (GET /activations) and fetch a synthetic sample with Manage notification endpoints (GET /hooks/sample?event_type=submission.completed). It cannot read guest records or styles, ingest, register endpoints, or send network tests. For a secure receiver test, use a live key with Manage notification endpoints, register an endpoint, install its returned signing secret, then call POST /test/deliveries with its endpoint_id. That sends only synthetic data with test: true, uses the known endpoint secret, and is limited to 10 per key per minute. A live key is also required for real ingest/idempotency drills in an isolated rehearsal activation; accepted ingest spends a credit.
Rate limits.Each key may make 300 requests per minute and each source address 600 per minute; sending photos in is limited to 60 requests per key per minute. A 429 carries Retry-After; stop until it elapses. The full rule set, including what the headers report, is in Partner API errors and limits.
Keys are account credentials.Never place a key in browser code or commit it to source control. Use one key per application so a leak can be revoked without breaking the others.
The account switch overrides every key.If Snapbar disables integrations for the account, every key answers integrations_disabled until it is re-enabled. Queued deliveries pause rather than fail.

Tips

Use a registered endpoint and a live manage-webhooks key for signed synthetic tests; test keys are limited to activation metadata and sample reads.
Revoke keys for finished events instead of leaving them active.

Helpful links

OpenAPI document

Partner API reference Receive signed webhooks at your own endpoint Partner API errors and limits Get started with integrations