Skip to main content

​
Creating Your First Site

Sites are the core of PixelPatrol - they represent the websites or applications you want to protect with content moderation. This guide will walk you through creating your first site.

​
Prerequisites

Before you begin, make sure you have:

​
Step 1: Navigate to Sites

  1. From the dashboard, click Sites in the navigation menu
  2. You’ll see the Sites overview page
  3. Click the “Add New Site” button
Sites Overview Page

​
Step 2: Basic Site Information

Fill in the basic details for your site:
​
name
string
required
A friendly name for your site (e.g., “Main Website”, “Mobile App”)
​
url
string
required
The full URL of your site (e.g., https://example.com)
​
description
string
Important: Description that provides context to the AI moderation system about your site’s purpose, target audience, and content standards. This helps the AI make appropriate moderation decisions based on your site’s specific context.

​
Example Configuration

{
  "name": "Community Forum",
  "url": "https://forum.example.com",
  "description": "A professional business community forum for discussing industry trends, networking, and sharing business insights. Target audience: working professionals aged 25-55. Content should be business-appropriate, professional, and suitable for workplace discussion."
}
The URL is used for webhook callbacks and site identification. Make sure it’s accessible from the internet if you plan to use webhooks.

​
Step 3: Configure Moderation Settings

​
Select Moderation Type

Choose how content will be moderated for this site:
  • AI Moderation
  • Rule-Based
  • Hybrid
Automated AI-Powered Moderation Best for: High-volume content, real-time moderation needs - Content is automatically analyzed by AI - Instant moderation decisions - Configurable confidence thresholds
AI moderation uses advanced models to detect inappropriate content, spam, and policy violations.

​
Set Confidence Threshold

If using AI moderation, configure the confidence threshold:
  • Low (60-70%): More content flagged, fewer false negatives
  • Medium (70-85%): Balanced approach
  • High (85-95%): Only very confident violations flagged
Start with a medium threshold (75%) and adjust based on your moderation results.

​
Step 4: Webhook Configuration (Optional)

Webhooks allow PixelPatrol to notify your application when moderation decisions are made.

​
Enable Webhooks

1

Toggle Webhooks On

Click the webhook toggle to enable webhook notifications
2

Enter Webhook URL

Provide your endpoint URL that will receive moderation results https://api.example.com/webhooks/moderation
3

Generate Webhook Secret

Click “Generate Secret” to create a secure webhook signing key
Save this secret immediately - it won’t be shown again!

​
Webhook Payload Example

Your webhook endpoint will receive POST requests with this structure: 
{
  "event": "moderation.completed",
  "timestamp": "2024-01-15T10:30:00Z",
  "data": {
    "media_id": "123e4567-e89b-12d3-a456-426614174000",
    "status": "flagged",
    "confidence": 0.89,
    "categories": ["violence", "explicit"],
    "metadata": {
      "user_id": "user123",
      "context": "forum_post"
    }
  }
}
Learn more about webhook integration →

​
Step 5: Rule Group Assignment (Optional)

If you have existing rule groups, you can assign them to your site:
  1. In the “Rule Groups” section, click “Assign Rule Groups”
  2. Select the rule groups you want to apply
  3. Order them by priority (rules are evaluated top to bottom)
Rule Group Assignment
Rule groups allow you to reuse moderation rules across multiple sites. You can create rule groups later if you don’t have any yet.

​
Step 6: Review and Create

Before creating your site, review your configuration: Click “Create Site” to save your configuration.

​
Step 7: Get Your Site Key

After creating your site, you’ll receive a site key:
  1. Copy the site key shown in the success message
  2. Store it securely in your application’s environment variables
  3. You can always retrieve it later from the site settings
# Example .env file
PIXELPATROL_SITE_KEY=site_xxxxxxxxxxxxxxxxxxxx

​
Testing Your Site

Now that your site is created, let’s test the integration:

​
Quick Test

  1. Navigate to your site’s detail page
  2. Click “Test Moderation”
  3. Upload a test image or enter test text
  4. View the moderation results

​
API Test

Test your integration with a simple API call: 
curl -X POST https://api.pixelpatrol.net/functions/v1/submit-media \
  -H "Content-Type: application/json" \
  -d '{
    "api_key": "site_xxxxxxxxxxxxxxxxxxxx",
    "body": "This is a test message",
    "app_media_id": "test-123",
    "metadata": {
      "user_id": "test_user"
    }
  }'

​
Managing Your Site

After creation, you can:

View Analytics

Monitor moderation statistics and trends

Edit Settings

Update configuration, thresholds, and webhooks

View Logs

Review webhook delivery logs and errors

Manage Rules

Add or modify rule groups for this site

​
Common Configuration Patterns

​
E-commerce Site

{
  "name": "Product Reviews",
  "description": "E-commerce platform for outdoor sporting goods. Users post product reviews, photos of gear in use, and outdoor activity content. Target audience: outdoor enthusiasts, athletes, ages 18-65. Content should be family-friendly and focused on product experiences.",
  "moderation_type": "hybrid",
  "confidence_threshold": 0.8,
  "rule_groups": ["spam_detection", "competitor_mentions"]
}

​
Social Platform

{
  "name": "User Posts",
  "description": "General social media platform for adults to share life updates, photos, and discussions. Target audience: adults 18+. Content standards: no explicit material, hate speech, or dangerous activities. Casual social content is encouraged.",
  "moderation_type": "ai",
  "confidence_threshold": 0.75,
  "webhook_enabled": true,
  "real_time": true
}

​
Corporate Website

{
  "name": "Contact Forms",
  "description": "Professional corporate website contact forms for a financial services company. All content should be business-appropriate, professional, and suitable for client communication. No promotional content or spam.",
  "moderation_type": "rules",
  "rule_groups": ["profanity_filter", "spam_detection"]
}

​
Troubleshooting

  • Verify your webhook URL is publicly accessible - Check that SSL certificate is valid (HTTPS required) - Review webhook logs in the site detail page - Ensure your endpoint returns 200 OK status
  • Confirm you’re using the correct site key - Check that the site is active - Verify your subscription has available moderations - Try regenerating the site key in settings
  • Adjust the confidence threshold - Review and update your rule groups - Check if content type matches configuration - Contact support with example content

​
Best Practices

Site Organization Tips:
  1. Use descriptive names: “Mobile App - User Comments” instead of “App 1”
  2. Write detailed descriptions: Provide clear context about your site’s purpose, audience, and content standards to help AI make appropriate moderation decisions
  3. Group by purpose: Create separate sites for different content types
  4. Document webhook endpoints: Keep track of which endpoints handle which sites
  5. Test thoroughly: Always test moderation settings with real content samples
  6. Monitor regularly: Check analytics to fine-tune your configuration

​
Next Steps

Great job! Your site is now ready to moderate content. Here’s what to do next:

Set Up Your Team

Invite team members to help manage moderation

Create Custom Rules

Define specific moderation rules for your content

Integrate the API

Start sending content for moderation

Choose a Plan

Select the right subscription for your volume