Skip to main content

Event Overview

The webhook.test.ping event is a special test event that can be triggered from the Pixel Patrol dashboard to verify your webhook endpoint is correctly configured and receiving events.
Test webhooks have a different signature format. The signature is included in the JSON body under _pixelpatrol_signature instead of the X-PixelPatrol-Signature header.

Payload Structure

Payload Fields

string
required
The event type. Always webhook.test.ping for test events.
string
required
ISO 8601 timestamp of when the test was sent.
string
required
The site ID this test webhook is for.
boolean
required
Always true for test events.
string
required
A human-readable test message.
string
required
HMAC-SHA256 signature for verification (in body for test events).

Verification Differences

Test webhooks require special handling for signature verification:

Testing Your Integration

  1. Configure Webhook URL: Set your endpoint URL in the Pixel Patrol dashboard
  2. Add Webhook Secret: Generate and save a secure webhook secret
  3. Send Test Event: Click “Test Webhook” button in the dashboard
  4. Verify Receipt: Check your logs for the test event
  5. Confirm Response: Ensure your endpoint returns 200 OK

Example Response

Your endpoint should return a 2xx status code to indicate successful receipt:

Common Issues

  • 401 Unauthorized: Signature verification failed - check your webhook secret
  • 404 Not Found: Webhook URL is incorrect or not accessible
  • 500 Server Error: Your endpoint has an error - check server logs
  • Timeout: Endpoint took too long to respond (>30 seconds)