Skip to main content
POST
/
webhooks
Create webhook
curl --request POST \
  --url https://api.proxyjam.com/public/v1/webhooks \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "url": "<string>",
  "enabled": true
}
'
{
  "signing_secret": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.proxyjam.com/llms.txt

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

Creates a new endpoint and returns a one-time signing secret. Save this secret immediately; it is not retrievable later.

Request body

url
string
required
Destination URL for webhook delivery.
enabled
boolean
Whether the endpoint is active immediately. Defaults to true.

Response

Returns endpoint fields plus:
signing_secret
string
One-time secret used by the receiver to verify X-ProxyJam-Signature.

Notes

  • In non-development environments, the URL must use HTTPS.
  • Only one active endpoint is allowed per user for proxy.status_changed.

Example

curl -X POST https://api.proxyjam.com/public/v1/webhooks \
  -H "X-API-Key: pj_AbCdEf..." \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com/hook",
    "enabled": true
  }'