Create a webhook endpoint
curl --request POST \
--url https://api.praxa.io/v1/webhooks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"url": "<string>",
"event_types": [
{}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({url: '<string>', event_types: [{}]})
};
fetch('https://api.praxa.io/v1/webhooks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.praxa.io/v1/webhooks"
payload = {
"url": "<string>",
"event_types": [{}]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"endpoint": {
"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"
},
"signing_secret": "example-secret-not-for-production"
}
Webhooks
Create a webhook endpoint
Create a Praxa webhook endpoint, capture its one-time signing secret, and verify signed delivery with least-privilege scopes.
POST
/
v1
/
webhooks
Create a webhook endpoint
curl --request POST \
--url https://api.praxa.io/v1/webhooks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"url": "<string>",
"event_types": [
{}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({url: '<string>', event_types: [{}]})
};
fetch('https://api.praxa.io/v1/webhooks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.praxa.io/v1/webhooks"
payload = {
"url": "<string>",
"event_types": [{}]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"endpoint": {
"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"
},
"signing_secret": "example-secret-not-for-production"
}
Create a Praxa webhook endpoint, capture its one-time signing secret, and verify signed delivery with least-privilege scopes.
Availability: Partner preview. Required scopes:
runs:write, runs:read.Authenticate safely
Create a disposable personal workspace API key with exactlyruns:write and 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
string
required
url request field.
array<run.accepted | run.started | run.progress | approval.required | approval.resolved | run.completed | run.failed | run.cancelled>
required
event_types request field.
string
description request field.
Runnable request examples
curl --fail-with-body -X POST 'https://api.praxa.io/v1/webhooks' \
-H "Authorization: Bearer $PRAXA_API_KEY" \
-H "Content-Type: application/json" \
--data '{
"url": "https://events.example.com/webhooks/praxa",
"event_types": [
"run.completed",
"run.failed"
],
"description": "Production task outcomes"
}'
const response = await fetch("https://api.praxa.io/v1/webhooks", {
"method": "POST",
"headers": {
"Authorization": `Bearer ${process.env.PRAXA_API_KEY}`,
"Content-Type": "application/json"
},
"body": JSON.stringify({
"url": "https://events.example.com/webhooks/praxa",
"event_types": [
"run.completed",
"run.failed"
],
"description": "Production task outcomes"
})
});
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
payload = json.dumps({
"url": "https://events.example.com/webhooks/praxa",
"event_types": [
"run.completed",
"run.failed"
],
"description": "Production task outcomes"
}).encode()
req = request.Request(
"https://api.praxa.io/v1/webhooks",
method="POST",
headers={
"Authorization": f"Bearer {os.environ['PRAXA_API_KEY']}",
"Content-Type": "application/json"
},
data=payload,
)
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
A201 response creates the endpoint and returns its signing secret exactly once.
Successful response
201 — Endpoint metadata and its one-time signing secret.object
required
endpoint response field.
string
required
Returned only when the endpoint is created.
{
"endpoint": {
"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"
},
"signing_secret": "example-secret-not-for-production"
}
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
- Store the secret in a secret manager immediately.
- Trigger one disposable matching event and verify its raw-body signature.
- List the endpoint and confirm the secret is no longer returned.
Retry, cleanup, and production use
- Treat
401,403, and409as authority or state signals, not generic retry prompts. - For
429or 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.
Last modified on August 14, 2026