Skip to main content

Webhook Events

This page documents the webhook events specific to deposit accounts. For information on setting up webhooks, see Webhooks.

account.created

Occurs when a Deposit Account is successfully created. See the Create Deposit Account API.

See full event payload and details at account.created.


account.closed

Occurs when a Deposit Account is closed. Closing an account is irreversible and can only be done by an Org user. See the Close Account API.

See full event payload and details at account.closed.


account.frozen

Occurs when a Deposit Account is frozen. A frozen account behaves like a closed account, but the state is temporary. See the Freeze Account API.

See full event payload and details at account.frozen.


account.unfrozen

Occurs when a previously frozen Deposit Account is unfrozen. See the Unfreeze Account API.

See full event payload and details at account.unfrozen.


account.reopened

Occurs when a closed Deposit Account is reopened. See the Reopen Account API.

See full event payload and details at account.reopened.


account.updated

Occurs when a Deposit Account is updated, such as when tags or the deposit product are modified. See the Update Account API.

See full event payload and details at account.updated.


accountHold.created

Occurs when an AccountHold is created on a deposit account. See the Create Account Hold API.

See full event payload and details at accountHold.created.


accountHold.released

Occurs when an AccountHold is released — including a full release, a partial release, or an automatic release when the hold expires. See the Release Account Hold API.

See full event payload and details at accountHold.released.