Skip to main content

API Keys

API keys let an external system (for example your booking or OMS tool) call Kazenly’s Public API on your inbox. Keys live under Settings → Data & CRM → API Keys.

Only admins and managers can create or revoke keys. Agents see a short message that they cannot manage keys.

Open API Keys​

  1. Open Settings.
  2. Under Data & CRM, select API Keys.

Page title: API Keys
Lead: Keys authenticate Stampede / OMS calls… Secrets are shown once — we cannot retrieve them later.

Empty: No API keys yet

Create a key​

  1. Click Create key.
  2. In Create API key, enter a Name.
  3. Choose Scopes (at least one):
ScopeMeaning
contacts.writeCreate or update contacts and field values.
events.inboundAccept OMS / booking events into Kazenly.
messages.send_templateSend approved Utility templates from a destination map.
flows.triggerReserved for later — starting bot flows remotely.
consent.writeCan change campaign addressability. Enable only when required.
  1. Optionally leave Include signing secret on (needed later to verify inbound event signatures).
  2. Click Create key.

Copy your secrets now​

After create, the dialog switches to Copy your secrets now:

  • API key — copy once (starts with kz_…)
  • Signing secret — when included, copy once

Tick I have copied the secret(s). Do not show them again. then confirm. Kazenly cannot show the full secret again — mint a new key if you lose it.

Quick start samples​

On the API Keys page, Quick start shows sample requests. Replace the placeholder secret with the value you copied at create time. Use:

  • Copy /me curl
  • Copy /contacts curl — upsert a contact (needs contacts.write)
  • Copy /events curl — post an inbound event (needs events.inbound and an Event Destination)

Revoke a key​

Revoke opens Revoke this API key? — confirm with Revoke key. Revoked keys stop working and show as Revoked in the list.