Quickstart

End state: feedback button on your site, a working API call from your terminal, and a webhook arriving at a localhost tunnel. Skip the parts you don't need.

Prerequisites

• A Feedjolt workspace. Sign up if you don't have one.
• Your workspace slug - the URL part. Find it at Dashboard -> Settings -> General.
• 10 minutes.

1. Install the widget (2 min)

Paste this before </body> on any page of your site:

<script async src="https://www.feedjolt.com/widget-loader.js"
        data-workspace="YOUR_WORKSPACE_SLUG"></script>

Reload the page. You should see a floating "Feedback" button.

Click it; the widget opens. Submit a test post. It should appear in your dashboard at Dashboard -> Boards -> [your default board] within seconds.

2. Get an API key (3 min)

Dashboard -> Settings -> API keys -> New key.

• Name it something honest: local-dev-marc, not key.
• Scopes: pick read-only scopes to start.
• Copy the key when shown. It starts with fjk_. You won't see it again.

Test it (replace YOUR_BOARD_SLUG with one of your boards):

curl -H "Authorization: Bearer fjk_YOUR_KEY" \
  "https://api.feedjolt.com/api/v1/boards/YOUR_BOARD_SLUG/posts?limit=5"

You should get JSON with up to 5 posts. If you get 401, the key is wrong or revoked. If 403, the scope is too narrow.

The full endpoint reference is at https://api.feedjolt.com/docs.

3. Receive a webhook (5 min)

For local dev, you'll need a tunnel. We recommend ngrok or Cloudflare Tunnel.

ngrok http 3000
# -> https://abc123.ngrok-free.app

In your code, accept POST requests:

// Node + Express
import express from "express";
const app = express();
app.use(express.json());

app.post("/feedjolt-webhook", (req, res) => {
  console.log("event:", req.headers["x-feedjolt-event"]);
  console.log("body:", req.body);
  res.status(200).send("ok");
});

app.listen(3000);

In Feedjolt: Dashboard -> Settings -> Webhooks -> New endpoint.

• URL: https://abc123.ngrok-free.app/feedjolt-webhook
• Events: pick a few (e.g., post.created, status.changed).
• Click Save. Copy the signing secret.

Trigger an event by submitting a feedback post (use the widget you just installed). Within ~5 seconds, your endpoint should receive a POST.

Sign verification is essential before going to production. See Webhooks: signing.

4. Cleanup

• Revoke the API key when done testing: Settings -> API keys -> Revoke.
• Delete the test webhook endpoint: Settings -> Webhooks -> Delete.
• Delete test posts: open the post -> Delete, or use the API.

What next

• Widget config - the five data-* attributes.
• Webhook signing - verify the requests are really from us.
• API reference - every endpoint, with try-it.

If anything in this guide didn't work, file a bug - we want this guide to be friction-free.