Skip to main content
PATCH
PATCH /v1/webhook-endpoints/{endpointId}
Send any of name, url, events and enabled. Fields you leave out don’t change.
  • Enabling requires a verified endpoint. Otherwise the request returns 409 WEBHOOK_NOT_VERIFIED.
  • Changing the URL turns the endpoint off and clears its verification and health state. Verify the new URL, then enable it in a separate request. Changing the URL and enabling in the same request returns 409 WEBHOOK_NOT_VERIFIED.
  • Pausing with "enabled": false stops new events from being queued for this endpoint.
Prava can also pause an endpoint automatically after repeated delivery failures; it keeps queuing new subscribed events while it waits. See Delivery and retries.

Authorizations

Authorization
string
header
required

Your secret key: sk_test_* (sandbox) or sk_live_* (production).

Path Parameters

endpointId
string
required

Body

application/json
name
string
Required string length: 1 - 80
url
string<uri>

Public HTTPS port 443, no query, userinfo or redirects.

Maximum string length: 2048
events
enum<string>[]
Required array length: 1 - 16 elements
Available options:
payment.credentials_ready,
payment.succeeded,
payment.failed,
card_enrollment.completed,
card_enrollment.failed,
card_enrollment.cancelled,
card_enrollment.expired,
mandate.created,
mandate.creation_failed,
mandate.creation_cancelled,
mandate.creation_expired,
mandate.paused,
mandate.resumed,
mandate.cancelled,
mandate.expired,
quote.request_failed
enabled
boolean

Response

Successful operation; endpoints never include stored signing secrets.

endpoint
object
required