Struct plaid::model::SyncUpdatesAvailableWebhook

pub struct SyncUpdatesAvailableWebhook {
    pub environment: String,
    pub historical_update_complete: bool,
    pub initial_update_complete: bool,
    pub item_id: String,
    pub webhook_code: String,
    pub webhook_type: String,
}

Fired when an Item’s transactions change. This can be due to any event resulting in new changes, such as an initial 30-day transactions fetch upon the initialization of an Item with transactions, the backfill of historical transactions that occurs shortly after, or when changes are populated from a regularly-scheduled transactions update job. It is recommended to listen for the SYNC_UPDATES_AVAILABLE webhook when using the /transactions/sync endpoint. Note that when using /transactions/sync the older webhooks INITIAL_UPDATE, HISTORICAL_UPDATE, DEFAULT_UPDATE, and TRANSACTIONS_REMOVED, which are intended for use with /transactions/get, will also continue to be sent in order to maintain backwards compatibility. It is not necessary to listen for and respond to those webhooks when using /transactions/sync.

After receipt of this webhook, the new changes can be fetched for the Item from /transactions/sync.

Note that to receive this webhook for an Item, /transactions/sync must have been called at least once on that Item. This means that, unlike the INITIAL_UPDATE and HISTORICAL_UPDATE webhooks, it will not fire immediately upon Item creation. If /transactions/sync is called on an Item that was not initialized with Transactions, the webhook will fire twice: once the first 30 days of transactions data has been fetched, and a second time when all available historical transactions data has been fetched.

This webhook will fire in the Sandbox environment as it would in Production. It can also be manually triggered in Sandbox by calling /sandbox/item/fire_webhook.

Fields

environment: String

The Plaid environment the webhook was sent from

historical_update_complete: bool

Indicates if historical pull information (maximum transaction history requested, up to 2 years) is available.

initial_update_complete: bool

Indicates if initial pull information (most recent 30 days of transaction history) is available.

item_id: String

The item_id of the Item associated with this webhook, warning, or error

webhook_code: String

SYNC_UPDATES_AVAILABLE

webhook_type: String

TRANSACTIONS

Trait Implementations

impl Clone for SyncUpdatesAvailableWebhook

fn clone(&self) -> SyncUpdatesAvailableWebhook

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SyncUpdatesAvailableWebhook

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SyncUpdatesAvailableWebhook

fn default() -> SyncUpdatesAvailableWebhook

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SyncUpdatesAvailableWebhook

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SyncUpdatesAvailableWebhook

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Serialize for SyncUpdatesAvailableWebhook

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.