Generate and use API keys and webhooks

Create API keys to access Omnifox programmatically and set up webhooks to receive real-time events.

Jun 22, 2026

Watch this step in the video · Create an API key

If you want to connect Omnifox with your own systems or automate actions, the REST API and webhooks are your best allies. API keys authenticate your API calls; webhooks notify you the instant something happens in your workspace. Here you'll learn how to generate and use both.

Generate an API key

  1. Open API Keys in the side menu.
  2. Press New API key.
  3. Give it a descriptive name (for example, "Online store integration").
  4. Select the permissions (scopes) it needs: contacts, conversations, messages, etc.
  5. Press Generate. Copy the key right away: for security it is shown only once.

Store the key somewhere safe (a secrets manager). If you lose it, revoke it and create a new one.

Use your API key

Include the key in the Authorization header of every request:

  • Authorization: Bearer YOUR_API_KEY
  • The REST API V1 lives at /api/v1/* (for example, https://omnifox.io/api/v1/contacts).
  • Respect the rate limits; if you receive a 429, wait and retry.

Set up a webhook

  1. Open Webhooks in the side menu.
  2. Press New webhook.
  3. Paste the destination URL (a public endpoint on your server that accepts POST).
  4. Check the events you want to receive: incoming message, conversation created, contact updated, etc.
  5. Save. Omnifox will send a POST with a JSON body each time the event occurs.

Verify and secure your webhooks

  • Every delivery includes a signature in the headers; validate it with your webhook secret to confirm the event is legitimate.
  • Respond with a 200 quickly. If your endpoint fails or is slow, Omnifox will retry with backoff.
  • Always use HTTPS.

Best practices

  • Create one API key per integration, so you can revoke one without affecting the others.
  • Grant only the minimum permissions needed.
  • Log every webhook received to make debugging easier.

Tip: test your webhooks with a tool like a request-inspection endpoint before pointing them at production. You'll see the exact JSON format and avoid surprises.

Was this helpful?

Related articles

Message us on WhatsApp