VEvectorize
Webhooks

Register webhook

Changed on

Register a webhook endpoint to receive event notifications for this bank.

post/v1/default/banks/{bank_id}/webhooks

Request

Path parameters

bank_idstring required

Headers

authorizationstring nullable

Request body

urlstring required

HTTP(S) endpoint URL to deliver events to

secretstring nullable

HMAC-SHA256 signing secret (optional)

event_typesstring[]

List of event types to deliver. Supported: 'retain.completed', 'consolidation.completed', 'memory_defense.triggered'.

enabledboolean

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

  • 4fda98b75f63Revision changes
    • warning

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

  • 0d08f271b9dbRevision changes
    • 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