pinned.events

Developer documentation

API Security Best Practices

Store keys server-side, use least privilege, rotate and revoke keys, and keep secrets out of logs.

Secure your Pinned Events API integration with server-side API key storage, scoped permissions, key rotation, safe logging, and duplicate-safe retries.

Store keys server-side

  • Keep API keys in server-side environment variables or a secrets manager.
  • Never place API keys in browser JavaScript, public mobile apps, static config files, or repositories.
  • Do not log full API keys, key hashes, sensitive request payloads, or private event content.

Use least privilege

Give each integration only the scopes it needs. Use one key per integration so revoking a compromised key has a small blast radius.

Rotate and revoke keys

Create a replacement key, deploy the new secret, verify traffic, then revoke the old key. Revocation is soft and preserves audit metadata.

Safe logging

Log request IDs, status codes, route names, and non-sensitive integration identifiers. Do not log full API keys, key hashes, Authorization headers, private event payloads, or partner-submitted secrets.

Related pages

Core resources