Update webhook configuration

View as Markdown

Updates URL, description, and/or event type subscriptions. Only provided fields are changed; event_types replaces the full allowlist.

Authentication

x-api-keystring

RootPay API key sent in the x-api-key header. Keys are environment-scoped: live_* for production, test_* for sandbox.

Path parameters

webhook_idstringRequiredformat: "uuid"

Request

This endpoint expects an object.
urlstring or nullOptionalformat: "uri"1-2083 characters
descriptionstring or nullOptional
event_typeslist of enums or nullOptional
Replace the full subscription allowlist when provided.

Response

Webhook configuration updated successfully
dataobject
warningstring or null