Skip to main content
PATCH
Update a webhook endpoint
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 exactly runs: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

What success means

A 200 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.

Handle failures

Example problem

Verify the result

  1. Read the endpoint list and confirm the changed fields.
  2. Trigger only an event allowed by the new filter.
  3. Confirm a foreign endpoint ID fails closed.

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