Webhook API Integration Guide
How to set up and use the Convert Fleet Webhook API to receive real-time conversion status notifications without polling.
You need an API key to follow this guide. Get a free API key →
1What is a Webhook?
Instead of polling the API to check if a conversion is done, a webhook lets Convert Fleet call YOUR endpoint when the job completes. This is more efficient and real-time.
2Set Up Your Webhook Endpoint
Create a public HTTPS endpoint that can receive POST requests. Here's a simple Express.js example.
const express = require('express');
const app = express();
app.use(express.json());
app.post('/webhook/convert-fleet', (req, res) => {
const { status, downloadUrl, error } = req.body;
if (status === 'completed') {
console.log('Conversion done! Download:', downloadUrl);
// Fetch and save the file using downloadUrl
} else if (status === 'failed') {
console.error('Conversion failed:', error);
}
res.sendStatus(200); // Acknowledge receipt
});
app.listen(3000, () => console.log('Webhook server running on port 3000'));3Register Your Webhook URL
Go to your Convert Fleet dashboard > Settings > Webhooks and add your public HTTPS endpoint URL.
4Test the Webhook
Use the "Test Webhook" button in your dashboard to send a sample payload to verify your endpoint is working.
That's it!
You've successfully integrated the Convert Fleet API. Check the API reference for the full list of parameters and error codes.
Related API Endpoints
More Integration Guides
Start Building Today
Free tier includes 200 free credits (valid 30 days from signup). Pro plan unlocks unlimited API access.