Help Center
Simple guides to get you started
Webhooks
Get real-time notifications when things happen in URLPixel. Perfect for automation, monitoring, and integrating URLPixel into your existing workflows.
What are webhooks? (The simple explanation)
🔔 Think of webhooks like push notifications for your apps
- When something happens in URLPixel, we instantly notify your app
- No need to constantly check - we’ll tell you when it’s ready
- Perfect for connecting URLPixel to other tools and services
Screenshot created → Instant notification → Your app responds
Blog Automation
Automatically add new screenshots to your blog posts or portfolio
Team Notifications
Alert your team in Slack when screenshots are ready or limits approached
Backup & Archive
Automatically save screenshots to your cloud storage or database
What events can you listen for?
Screenshot Events
screenshot.createdPopularNew screenshot successfully generated
screenshot.failedPopularScreenshot generation failed
Usage Events
usage.warningPopularApproaching limits (80% or 90% usage)
usage.exceededMonthly screenshot quota reached
Site Management
site.createdNew site added to account
site.updatedSite information modified
site.deletedSite removed from account
Try creating a webhook
Create Your First Webhook
Try creating a webhook endpoint
Give it a name to remember what it’s for
Where URLPixel should send notifications
When a new screenshot is successfully generated
When screenshot generation fails
When approaching monthly limits (80%, 90%)
When monthly screenshot quota is reached
When a new site is added
When site information is modified
When a site is removed
Security & reliability
Built-in security
- • HMAC SHA-256 signatures - Verify events actually came from URLPixel
- • Secret keys - Each webhook gets a unique secret for signature verification
- • HTTPS only - All webhook deliveries use secure connections
- • Auto-disable - Failing endpoints are automatically disabled after 10 failures
Reliable delivery
- • 5 retry attempts - Exponential backoff over 12 hours
- • Delivery tracking - See exactly when events were sent
- • Test endpoints - Verify your webhook before going live
- • Plan-based limits - 2-10 webhooks depending on your plan
Example webhook receiver
const crypto = require('crypto');
const express = require('express');
const app = express();
app.post('/webhooks/urlpixel',
express.raw({type: 'application/json'}),
(req, res) => {
// Verify the signature
const signature = req.headers['x-urlpixel-signature'];
const expectedSignature = crypto
.createHmac('sha256', process.env.WEBHOOK_SECRET)
.update(req.body, 'utf8')
.digest('hex');
if (signature !== `sha256=${expectedSignature}`) {
return res.status(401).send('Invalid signature');
}
// Handle the event
const event = JSON.parse(req.body);
const eventType = req.headers['x-urlpixel-event'];
switch (eventType) {
case 'screenshot.created':
console.log('New screenshot:', event.data.url);
// Add to your CMS, send notification, etc.
break;
case 'usage.warning':
console.log('Usage warning:', event.data.percentage);
// Consider upgrading plan, notify team, etc.
break;
}
res.status(200).send('OK');
});Ready to get started?
Set up your endpoint
Create a URL on your server that can receive POST requests
Create your webhook
Use our dashboard or API to register your endpoint with URLPixel
Test it works
Send a test event to make sure your endpoint receives and processes it correctly
Go live!
Start receiving real events and automate your workflows