RentFAX sends real-time POST notifications to your configured endpoint when key events occur. Use webhooks to keep your systems in sync without polling.
RentFAX can notify your application in real time when important events happen in the platform. When an event fires, RentFAX sends an HTTP POST request containing a JSON payload to the webhook URL you have configured for your organization. You can use these notifications to trigger workflows, update your own records, or alert your team automatically.
Webhooks are configured per organization. To set your endpoint URL, go to Settings → Webhooks in the RentFAX dashboard and enter the URL you want RentFAX to deliver events to. Only one URL can be active per organization at a time.
RentFAX delivers each event as an HTTP POST to your configured URL with the following request headers:
Content-Type: application/json
The body is a JSON object containing an event field that identifies the event type, along with a data object containing event-specific fields.
RentFAX does not currently sign webhook payloads with a signature header. You should restrict your webhook endpoint to only accept traffic from trusted sources, and consider validating the incoming event type and orgId fields against your own records before acting on a payload. Do not expose sensitive business logic behind an unauthenticated endpoint.
{ "event": "dispute.filed", "orgId": "org_7f3a2b1c9d", "data": { "disputeId": "dsp_8mPqR2nKxLtYwZ", "recordId": "RB-47291", "renterEmail": "jane.doe@example.com", "reason": "The payment compliance rating is incorrect. All payments were made on time per bank records.", "status": "open", "filedAt": "2024-04-17T09:15:42.000Z" }}
Fired when an identity verification check is completed for a renter. This event is triggered by RentFAX’s fraud detection process when a renter’s identity is evaluated against the network.
Your endpoint should respond with an HTTP 2xx status code as quickly as possible. If your processing logic is slow, acknowledge receipt immediately and handle the payload asynchronously.
import express from 'express';const app = express();app.use(express.json());app.post('/webhooks/rentfax', (req, res) => { const { event, orgId, data } = req.body; // Acknowledge receipt immediately res.sendStatus(200); // Handle the event asynchronously switch (event) { case 'report.submitted': console.log(`Report ${data.recordId} submitted. Risk score: ${data.riskScore}`); // TODO: sync to your database break; case 'dispute.filed': console.log(`Dispute ${data.disputeId} filed for record ${data.recordId}`); // TODO: notify your team break; case 'identity.check': console.log(`Identity check for ${data.renterEmail}: ${data.result}`); // TODO: update renter profile break; default: console.warn(`Unrecognised event type: ${event}`); }});app.listen(3000);
// app/api/webhooks/rentfax/route.tsimport { NextRequest, NextResponse } from 'next/server';export async function POST(req: NextRequest) { const payload = await req.json(); const { event, orgId, data } = payload; switch (event) { case 'report.submitted': // Handle report submission break; case 'dispute.filed': // Handle dispute break; case 'identity.check': // Handle identity check result break; default: // Ignore unknown events break; } return NextResponse.json({ received: true });}
RentFAX does not currently retry failed webhook deliveries. If your endpoint is unavailable or returns a non-2xx status, the event will not be resent. Design your integration to handle missed events by polling the relevant API endpoints if necessary.
