class Plaid::ProcessorSyncUpdatesAvailableWebhook
- Plaid::ProcessorSyncUpdatesAvailableWebhook
- Reference
- Object
Overview
This webhook is only sent to Plaid processor partners. 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 /processor/transactions/sync
endpoint. Note that when using /processor/transactions/sync
the older webhooks INITIAL_UPDATE
, HISTORICAL_UPDATE
, DEFAULT_UPDATE
, and TRANSACTIONS_REMOVED
, which are intended for use with /processor/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 /processor/transactions/sync
. After receipt of this webhook, the new changes can be fetched for the Item from /processor/transactions/sync
. Note that to receive this webhook for an Item, /processor/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 typically not fire in the Sandbox environment, due to the lack of dynamic transactions data. To test this webhook in Sandbox, call /sandbox/item/fire_webhook
.
Included Modules
- JSON::Serializable
- JSON::Serializable::Unmapped
- OpenApi::Json
- OpenApi::Validatable
Defined in:
plaid/models/processor_sync_updates_available_webhook.crConstructors
- .new(pull : JSON::PullParser)
-
.new(*, webhook_type : String | Nil = nil, webhook_code : String | Nil = nil, account_id : String | Nil = nil, initial_update_complete : Bool | Nil = nil, historical_update_complete : Bool | Nil = nil, environment : Plaid::WebhookEnvironmentValues | Nil = nil)
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Instance Method Summary
-
#==(other : self)
Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes.
- #account_id : String | Nil
-
#account_id=(new_value : String | Nil)
Custom attribute writer method checking allowed values (enum).
- #environment : Plaid::WebhookEnvironmentValues | Nil
-
#environment=(new_value : Plaid::WebhookEnvironmentValues | Nil)
Custom attribute writer method checking allowed values (enum).
-
#hash(hasher)
Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes.
- #historical_update_complete : Bool | Nil
-
#historical_update_complete=(new_value : Bool | Nil)
Custom attribute writer method checking allowed values (enum).
- #initial_update_complete : Bool | Nil
-
#initial_update_complete=(new_value : Bool | Nil)
Custom attribute writer method checking allowed values (enum).
-
#list_invalid_properties : Array(String)
Show invalid properties with the reasons.
-
#valid? : Bool
Check to see if the all the properties in the model are valid @return true if the model is valid
- #webhook_code : String | Nil
-
#webhook_code=(new_value : String | Nil)
Custom attribute writer method checking allowed values (enum).
- #webhook_type : String | Nil
-
#webhook_type=(new_value : String | Nil)
Custom attribute writer method checking allowed values (enum).
Instance methods inherited from module OpenApi::Json
after_initialize
after_initialize,
eql?(o : self)
eql?,
to_hash : Hash(String, JSON::Any)
to_hash,
to_json_any : JSON::Any
to_json_any
Class methods inherited from module OpenApi::Json
build_from_hash(hash : Hash)
build_from_hash,
build_from_json_any(json_any : JSON::Any)
build_from_json_any
Instance methods inherited from module OpenApi::Validatable
list_invalid_properties : Array(String)
list_invalid_properties,
list_invalid_properties_for(key : String) : Array(String)
list_invalid_properties_for,
valid? : Bool
valid?,
validate : Nil
validate
Constructor Detail
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Instance Method Detail
Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code
Custom attribute writer method checking allowed values (enum). @param [Object] account_id Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] environment Object to be assigned
Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code
Custom attribute writer method checking allowed values (enum). @param [Object] historical_update_complete Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] initial_update_complete Object to be assigned
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
Check to see if the all the properties in the model are valid @return true if the model is valid
Custom attribute writer method checking allowed values (enum). @param [Object] webhook_code Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] webhook_type Object to be assigned