Webhooks Overview

Webhooks are a way for your app to receive live notifications of activity on your user’s accounts.

Currently we support 5 different event types:

• Message Received
• New Follower
• New Subscriber
• Purchase Received
• Tip Received

Here’s how to use them:

1. Setup an endpoint on your backend to receive webhooks, this should be able to receive POST requests from our API
2. Navigate to the Fanvue Developer Area, select your app and go to the Webhooks tab
3. Enter the desired URL
4. Press Save and then enable the webhook by checking the box next to it

How deliveries work

• Each webhook is delivered as an HTTP POST with Content-Type: application/json.
• The request body contains an event-specific JSON payload.
• Your endpoint should return a 2xx response as soon as you successfully receive and persist the event.

Testing locally

• Expose your local server with a tunneling tool (for example, ngrok) and copy the public HTTPS URL.
• Set that URL in the Webhooks UI for the event type you want to receive.
• Trigger the event in a test environment and inspect the request reaching your server.

Example endpoint (Node.js / Express)

1
import express from "express";
2
3
const app = express();
4
app.use(express.json());
5
6
app.post("/webhooks/fanvue", (req, res) => {
7
  const event = req.body;
8
  res.sendStatus(200);
9
});
10
11
app.listen(3000);