List webhook endpoints

curl --request GET \
  --url https://api.praxa.io/v1/webhooks \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.praxa.io/v1/webhooks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "apiVersion": "v1",
  "data": [
    {
      "apiVersion": "v1",
      "id": "018f0000-0000-7000-8000-000000000001",
      "url": "https://example.com/praxa",
      "event_types": [
        "run.accepted"
      ],
      "status": "active",
      "createdAt": "2026-08-13T12:00:00.000Z",
      "updatedAt": "2026-08-13T12:00:00.000Z"
    }
  ]
}

GET

webhooks

List webhook endpoints

curl --request GET \
  --url https://api.praxa.io/v1/webhooks \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.praxa.io/v1/webhooks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "apiVersion": "v1",
  "data": [
    {
      "apiVersion": "v1",
      "id": "018f0000-0000-7000-8000-000000000001",
      "url": "https://example.com/praxa",
      "event_types": [
        "run.accepted"
      ],
      "status": "active",
      "createdAt": "2026-08-13T12:00:00.000Z",
      "updatedAt": "2026-08-13T12:00:00.000Z"
    }
  ]
}

List tenant-owned Praxa webhook endpoint metadata without exposing any endpoint signing secret.

Availability: Partner preview. Required scope: runs:read.

Authenticate safely

Create a disposable personal workspace API key with exactly runs:read. Send it as Authorization: Bearer $PRAXA_API_KEY. A Gateway OAuth token, Supabase JWT, provider credential, or organization memory key is not interchangeable with this key. The hosted playground sends the credential from your browser session to the documented API through the configured playground proxy. Use test data, never share the key, and revoke it when the check ends.

Request fields

This operation has no path, query, header, or JSON-body fields beyond bearer authentication.

Runnable request examples

curl --fail-with-body -X GET 'https://api.praxa.io/v1/webhooks' \
  -H "Authorization: Bearer $PRAXA_API_KEY"

const response = await fetch("https://api.praxa.io/v1/webhooks", {
  "method": "GET",
  "headers": {
    "Authorization": `Bearer ${process.env.PRAXA_API_KEY}`
  }
});
const text = await response.text();
if (!response.ok) throw new Error(`${response.status}: ${text}`);
console.log(text ? JSON.parse(text) : { status: response.status });

import json
import os
from urllib import error, request

req = request.Request(
    "https://api.praxa.io/v1/webhooks",
    method="GET",
    headers={
      "Authorization": f"Bearer {os.environ['PRAXA_API_KEY']}"
    },
)
try:
    with request.urlopen(req, timeout=30) as response:
        text = response.read().decode()
        print(json.loads(text) if text else {"status": response.status})
except error.HTTPError as exc:
    raise RuntimeError(f"{exc.code}: {exc.read().decode()}") from exc

What success means

A 200 response returns only endpoint metadata for the authenticated tenant; signing secrets must be absent.

Successful response

200 — Tenant-owned webhook endpoint metadata.

required

apiVersion response field.

array<object>

required

data response field.

{
  "apiVersion": "v1",
  "data": [
    {
      "apiVersion": "v1",
      "id": "018f0000-0000-7000-8000-000000000001",
      "url": "https://example.com/praxa",
      "event_types": [
        "run.accepted"
      ],
      "status": "active",
      "createdAt": "2026-08-13T12:00:00.000Z",
      "updatedAt": "2026-08-13T12:00:00.000Z"
    }
  ]
}

Handle failures

Response	Meaning	Safe action
`400 invalid_request`	The method, path, headers, query, or body failed strict validation.	Correct the request; do not retry unchanged input.
`401 authentication_failed`	The bearer key is missing, malformed, expired, or revoked.	Stop and replace the key through the authenticated console.
`403 authorization_failed`	The authenticated key lacks scope or tenant authority.	Request only the missing least-privilege scope; never substitute another tenant ID.
`429 rate_limited`	The principal exceeded a bounded rate.	Honor `retryAfterMs` or `Retry-After`, add jitter, and cap attempts.
retryable `5xx`	The server could not confirm a final response.	Reconcile reads or replay the exact keyed mutation before creating new work.

Example problem

{
  "type": "https://docs.praxa.io/problems/authorization-failed",
  "title": "Authorization failed",
  "status": 403,
  "code": "authorization_failed",
  "detail": "The API key does not grant the required scope.",
  "retryable": false
}

Verify the result

Confirm every endpoint belongs to the intended environment.
Require signing secrets to be absent.
Test with an under-scoped key.

Retry, cleanup, and production use

Treat 401, 403, and 409 as authority or state signals, not generic retry prompts.
For 429 or retryable 5xx responses, follow server retry guidance and keep a bounded attempt budget.
Move the request into a trusted application backend before production; never ship the Praxa key in browser or mobile code.
Revoke the disposable key, disable test webhooks, and erase disposable candidate data after validation.

Continue with API authentication, the failure and retry guide, and the end-to-end coverage matrix.

Last modified on August 14, 2026

Start here

Tasks, runs & usage

Webhooks

Memory candidates

List webhook endpoints

Authenticate safely

Request fields

Runnable request examples

What success means

Successful response

Handle failures

Verify the result

Retry, cleanup, and production use

​Authenticate safely

​Request fields

​Runnable request examples

​What success means

​Successful response

​Handle failures

​Verify the result

​Retry, cleanup, and production use

Authenticate safely

Request fields

Runnable request examples

What success means

Successful response

Handle failures

Verify the result

Retry, cleanup, and production use