Skip to main content
POST
/
pixelStripeApi
/
projects
/
test-webhook
curl -X POST https://api.streampixel.io/pixelStripeApi/projects/test-webhook \
  -H "Content-Type: application/json" \
  -d '{
    "apiKey": "[YOUR_API_KEY]",
    "userId": "[YOUR_USER_ID]",
    "projectId": "[YOUR_PROJECT_ID]"
  }'

{
  "success": true,
  "message": "Test webhook delivered",
  "statusCode": 200
}

Documentation Index

Fetch the complete documentation index at: https://docs.streampixel.io/llms.txt

Use this file to discover all available pages before exploring further.

Send a synthetic webhook.test payload to a project’s configured webhook URL and inspect the HTTP response your endpoint returned. Use this from CI, deploy scripts, or health checks to confirm your receiver is reachable, returns 2xx, and parses the payload correctly — without waiting for a real build event.

​
Typical workflow

1

Configure the webhook URL

In the dashboard, open Project Settings and save a publicly reachable HTTPS endpoint as the Webhook URL.
2

Call this endpoint

Send a POST to /projects/test-webhook with your apiKey, userId, and projectId.
3

Inspect the response

Streampixel returns the HTTP status code your webhook URL responded with so you can confirm it accepted the payload.
4

Wire it into CI

Run this call as part of your deploy pipeline so a misconfigured receiver fails fast instead of silently dropping real build events.

​
Prerequisites

RequirementWhere to get it
API KeyAPI authentication
User IDFinding your IDs
Project IDFinding your IDs
Webhook URLConfigured in Project Settings

​
Request body

​
apiKey
string
required
Your Streampixel API key. See API authentication.
​
userId
string
required
The ID of the account that owns the project.
​
projectId
string
required
The project whose webhook URL should be tested.

​
Response

​
success
boolean
true if Streampixel was able to reach your webhook URL and your endpoint responded with a 2xx status. false for any non-2xx response or network failure.
​
message
string
Human-readable summary of what happened (e.g., "Test webhook delivered", "Webhook endpoint returned non-2xx status").
​
statusCode
number
The HTTP status code returned by your webhook URL. 0 if Streampixel could not establish a connection at all.
curl -X POST https://api.streampixel.io/pixelStripeApi/projects/test-webhook \
  -H "Content-Type: application/json" \
  -d '{
    "apiKey": "[YOUR_API_KEY]",
    "userId": "[YOUR_USER_ID]",
    "projectId": "[YOUR_PROJECT_ID]"
  }'

{
  "success": true,
  "message": "Test webhook delivered",
  "statusCode": 200
}

​
How it works

1

Streampixel reads your project's webhook URL

The URL must already be saved in Project Settings. If it isn’t, the call returns 404.
2

A `webhook.test` payload is built

The payload uses the same shape as a real build event — see the webhook events reference.
3

Streampixel POSTs to your URL

With Content-Type: application/json, a 10-second timeout, and no retries.
4

The HTTP response is returned to you

Whatever status code your endpoint returned is reflected back in statusCode. success is true only if it was 2xx.
Run this call from your deploy pipeline as a smoke test. If success is false, fail the deploy — a broken webhook URL will silently drop production build events.

​
Common pitfalls

SymptomLikely cause
statusCode: 0Streampixel could not reach your URL at all (DNS, firewall, or non-routable address like localhost).
statusCode: 502 / 504Your endpoint is up but a reverse proxy in front of it is timing out or unhealthy.
statusCode: 200 but no log entryYour handler may be acknowledging too eagerly without parsing — confirm you read the body before returning 200.
Returns 404 No webhook URL configuredYou haven’t saved a webhook URL in Project Settings, or it was cleared.
Returns 401 UnauthorizedapiKey is missing, mistyped, or has been rotated.

​
Next steps

Webhook setup

Configure your webhook URL, choose events, and follow handler best practices.

Webhook event reference

Full payload shapes for every event Streampixel can deliver.