pinned.events

Developer documentation

API Keys and Scopes

Understand API key lifecycle, default quickstart scopes, owner-scoped channel access, and revocation behavior.

Create scoped API keys for Pinned Events integrations. Understand channels:read, events:create, owner access, one-time secrets, revocation, and least-privilege access.

What API keys are

An API key is a bearer secret tied to the user who created it. The key owner determines which channels can be listed or targeted by Public API requests.

Default scopes

New keys start with the minimum quickstart pair: channels:read and events:create. Existing keys are not silently changed when defaults change.

ScopeAllows
channels:readList channels available to the key owner.
events:createCreate events in channels available to the key owner.
events:readRead events available through the Public API.
events:updateUpdate supported event fields through the Public API.
media:createUpload media for use as event cover images.

Owner access

Scopes are necessary but not enough. Runtime authorization still verifies that the key owner has access to the target channel before a create, read, or update operation succeeds.

Missing scope behavior

When a valid API key does not include the scope required by a route, the API returns a 403 insufficient_scope response. Add only the missing scope that the integration actually needs.

Revoked, disabled, and expired keys

Revoked, disabled, and expired keys cannot authenticate Public API requests. Soft-revoked keys remain in audit history but do not count toward the active key cap.

Related pages

Core resources