API Keys & Webhooks: Connecting Ponkan to Your Tools

You might have heard terms like "API keys" and "webhooks" thrown around and thought they were only for developers. The truth is, even if you never write a single line of code, understanding these two features can unlock powerful automations for your business.

This guide explains what they are in plain English and shows you how to use them from your Ponkan dashboard.

What is an API key?

Think of an API key as a password that lets other software talk to your Ponkan account.

When you connect Ponkan to another tool — like your accounting software, email marketing platform, or inventory system — that tool needs a way to prove it has permission to access your data. Your API key is that proof.

It's similar to giving a house key to a trusted friend. They can come in and do specific things (check your orders, create invoices, update products), but only because you gave them the key.

When would you need an API key?

You might need an API key if you want to:

• Connect to Zapier or Make to automate workflows (e.g., "When a new order comes in, add a row to my Google Sheet")
• Sync with accounting software like QuickBooks or Xero
• Integrate with your website to display products or accept payments
• Use a third-party app that connects to Ponkan

Many of these tools will ask you to paste your Ponkan API key during setup. That's all there is to it.

Creating an API key

1. Go to Settings > API in your Ponkan dashboard
2. Click Create API Key
3. Give it a descriptive name (e.g., "Zapier integration" or "Website checkout")
4. Choose the permissions — what the key is allowed to do:
   • Read only — Can view data but can't change anything
   • Read & write — Can view and modify data (create orders, update products, etc.)
5. Click Create
6. Copy your key and paste it into the tool you're connecting

Important: Treat your API key like a password. Don't share it publicly or post it on social media. If you think a key has been compromised, you can revoke it and create a new one from the same settings page.

What is a webhook?

If an API key lets other tools talk to Ponkan, a webhook lets Ponkan talk to other tools.

A webhook is an automatic notification that Ponkan sends to a URL you specify whenever something happens — like a new order, a payment, or a refund.

Here's a real-world analogy: imagine you ask a restaurant to text you when your table is ready instead of waiting at the door. That text is like a webhook — the restaurant (Ponkan) reaches out to you (your tool) the moment something happens, without you having to keep checking.

When would you use webhooks?

Webhooks are useful when you want to react to events in real time:

• New order placed — Automatically send a thank-you email, update your inventory, or notify your team on Slack
• Payment received — Mark a project as paid in your project management tool
• Invoice overdue — Trigger a follow-up workflow in your CRM
• Refund issued — Update your accounting records

The possibilities depend on what tools you connect. If you use platforms like Zapier, Make, or n8n, webhooks are how those platforms "listen" for events from Ponkan.

Setting up a webhook

1. Go to Settings > Webhooks in your dashboard
2. Click Add Webhook
3. Paste the URL where you want notifications sent (your automation platform will give you this URL)
4. Select which events you want to listen for:
   • Order created
   • Payment completed
   • Invoice paid
   • Refund processed
   • Customer created
   • And more
5. Click Save

From now on, every time the selected event occurs, Ponkan will send a notification to that URL with all the relevant details.

A practical example

Let's say you run an online store and want to be notified on Slack every time someone makes a purchase.

1. In Zapier (or a similar tool), create a new "Zap" with a webhook trigger
2. Copy the webhook URL that Zapier gives you
3. In Ponkan, go to Settings > Webhooks and add that URL
4. Select "Order created" as the event
5. In Zapier, add a Slack action that posts a message to your sales channel

Now every time a customer buys something, you'll see a message in Slack with the order details — automatically.

Managing your keys and webhooks

Revoking API keys

If you no longer need a key or suspect it's been compromised:

1. Go to Settings > API
2. Find the key in your list
3. Click Revoke

The key stops working immediately. Any tools using it will lose access until you create and configure a new key.

Testing webhooks

When setting up a webhook for the first time, use the Send Test button in your dashboard. This sends a sample event to your URL so you can verify everything is connected before real transactions start flowing.

Viewing webhook history

Ponkan logs every webhook delivery, so you can see:

• When it was sent
• Whether it was delivered successfully
• The response from the receiving tool

If a delivery fails, Ponkan automatically retries several times.

Do I need a developer?

For simple integrations — connecting to Zapier, pasting an API key into another app — you don't need a developer at all. These are point-and-click setups.

For more advanced integrations — like building a custom storefront or creating your own automation scripts — you may want to involve someone technical. Ponkan's API documentation covers everything a developer would need.

What's next?

• Quick start guide — New to Ponkan? Start here for the basics
• Manage your team — Control who has access to API keys and settings
• Create checkout links — Start selling without any integrations at all