Update a webhook endpoint
curl --request PATCH \
--url https://api.praxa.io/v1/webhooks/{endpointId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"url": "<string>",
"event_types": [
{}
],
"description": {},
"status": {}
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({url: '<string>', event_types: [{}], description: {}, status: {}})
};
fetch('https://api.praxa.io/v1/webhooks/{endpointId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.praxa.io/v1/webhooks/{endpointId}"
payload = {
"url": "<string>",
"event_types": [{}],
"description": {},
"status": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"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"
}
Webhooks
Update a webhook endpoint
Update an existing Praxa webhook URL, event filter, or enabled state with a strict non-empty request.
PATCH
/
v1
/
webhooks
/
{endpointId}
Update a webhook endpoint
curl --request PATCH \
--url https://api.praxa.io/v1/webhooks/{endpointId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"url": "<string>",
"event_types": [
{}
],
"description": {},
"status": {}
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({url: '<string>', event_types: [{}], description: {}, status: {}})
};
fetch('https://api.praxa.io/v1/webhooks/{endpointId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.praxa.io/v1/webhooks/{endpointId}"
payload = {
"url": "<string>",
"event_types": [{}],
"description": {},
"status": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"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"
}
Update an existing Praxa webhook URL, event filter, or enabled state with a strict non-empty request.
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
endpointId path parameter.
string
url request field.
array<run.accepted | run.started | run.progress | approval.required | approval.resolved | run.completed | run.failed | run.cancelled>
event_types request field.
string | null
description request field.
active | disabled
status request field.
Runnable request examples
curl --fail-with-body -X PATCH 'https://api.praxa.io/v1/webhooks/endpoint-demo-0001' \
-H "Authorization: Bearer $PRAXA_API_KEY" \
-H "Content-Type: application/json" \
--data '{
"url": "https://example.com/praxa"
}'
const response = await fetch("https://api.praxa.io/v1/webhooks/endpoint-demo-0001", {
"method": "PATCH",
"headers": {
"Authorization": `Bearer ${process.env.PRAXA_API_KEY}`,
"Content-Type": "application/json"
},
"body": JSON.stringify({
"url": "https://example.com/praxa"
})
});
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://example.com/praxa"
}).encode()
req = request.Request(
"https://api.praxa.io/v1/webhooks/endpoint-demo-0001",
method="PATCH",
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
A200 response is the updated endpoint metadata; no signing secret is returned.
Successful response
200 — Updated endpoint metadata.v1
required
apiVersion response field.
string
required
id response field.
string
required
url response field.
array<run.accepted | run.started | run.progress | approval.required | approval.resolved | run.completed | run.failed | run.cancelled>
required
event_types response field.
string
description response field.
active | disabled
required
status response field.
string
required
createdAt response field.
string
required
updatedAt response field.
{
"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
- Read the endpoint list and confirm the changed fields.
- Trigger only an event allowed by the new filter.
- Confirm a foreign endpoint ID fails closed.
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