Quick Start

Get your first webhook delivered in under 2 minutes.

1. Create an Account

Sign up at app.promptjang.net or via the API:

curl -X POST https://api.promptjang.net/api/v1/auth/signup \
  -H "Content-Type: application/json" \
  -d '{
    "email": "[email protected]",
    "password": "your-password",
    "name": "Your Name"
  }'

Save the api_key from the response — you'll use it to send events.

2. Create an Endpoint

An endpoint is the target URL where PromptJang will deliver your webhooks:

curl -X POST https://api.promptjang.net/api/v1/endpoints \
  -H "Authorization: Bearer pj_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com/webhooks",
    "description": "My first endpoint"
  }'

Save the id from the response — this is your endpoint ID.

3. Send an Event

That's it — just POST JSON with your API key:

curl -X POST "https://api.promptjang.net/e/YOUR_ENDPOINT_ID" \
  -H "Authorization: Bearer pj_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "event_type": "order.created",
    "data": {
      "order_id": "ORD-001",
      "amount": 99.99
    }
  }'

Response:

{
  "id": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
  "status": "QUEUED"
}

4. Check Delivery Status

curl "https://api.promptjang.net/api/v1/events/a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6" \
  -H "Authorization: Bearer pj_live_YOUR_API_KEY"

Response includes all delivery attempts:

{
  "id": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
  "status": "DELIVERED",
  "delivery_attempts": [
    {
      "id": "da_f1e2d3c4...",
      "status_code": 200,
      "duration_ms": 145,
      "attempted_at": "2026-05-27T12:00:01Z"
    }
  ]
}

5. Replay if Needed

curl -X POST "https://api.promptjang.net/api/v1/events/a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6/replay" \
  -H "Authorization: Bearer pj_live_YOUR_API_KEY"

What Happens Behind the Scenes

1. PromptJang receives your JSON payload
2. Archives it for replay later
3. Queues it for delivery
4. Forwards it to your target URL
5. If the target returns non-2xx, retries with exponential backoff (up to 5 times)
6. Every attempt is logged with status code, latency, and error details
7. You can check status anytime via the API or dashboard

Next Steps

• Authentication — API key and session management
• Webhook Signatures — how we sign outbound webhooks
• Event State Machine — lifecycle and retries
• API Reference — all endpoints