Get your Oppy API key

An API key lets your own tools talk to Oppy. You need one to send events to Oppy from a CRM, a payment system, a form, Zapier or your own code.

Create a key

1. Sign in to Oppy.
2. Open API Keys. You can also reach it from Settings → API Keys.
3. Click Create New Key.
4. Give it a label that says where it will be used, such as “Stripe” or “Production server”. Leave the scope as account_admin.
5. Click Create Key, then copy the key right away. Oppy shows the full key only once. After that the list shows a masked version.

If you get a permission error, ask your account owner or an admin to create the key.

Use the key

Send it in the X-API-Key header on every request:

curl -X POST https://io.oppy.pro/api/events \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{"event_type": "payment_received", "message": "New payment from Jane Smith", "source": "stripe"}'

The event appears on your Events page right away. For every field and example, see the Events API guide.

If your tool can’t set headers

Contact the Oppy team for alternatives.

Keep it safe

• Treat the key like a password. An account_admin key has full access to your account.
• Use one key per tool, so you can turn one off without breaking the others.
• Never put the key in a website’s public code or a shared document.
• If a key may have leaked, delete it on the API Keys page and create a new one. A deleted key stops working at once and cannot be recovered.