Webhooks

Update one or more fields of a registered webhook. Only provided fields are changed.

patch/v1/default/banks/{bank_id}/webhooks/{webhook_id}

Request

Path parameters

bank_idstring required
webhook_idstring required

Headers

authorizationstring nullable

Request body

urlstring nullable

HTTP(S) endpoint URL

secretstring nullable

HMAC-SHA256 signing secret. Omit to keep existing; send null to clear.

event_typesstring[] nullable

List of event types

enabledboolean nullable

Whether this webhook is active

Response

Successful Response

idstring required
bank_idstring nullable required
urlstring required
secretstring nullable

Signing secret (redacted in responses)

event_typesstring[] required
enabledboolean required
created_atstring nullable
updated_atstring nullable

Changes

    • warning

      removed the optional property // from the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status