Class: Plaid::Webhook

Inherits:
BaseProduct show all
Defined in:
lib/plaid/products/item.rb

Overview

Public: Class used to call the Webhook sub-product

Defined Under Namespace

Classes: UpdateResponse

Instance Attribute Summary

Attributes inherited from BaseProduct

#client

Instance Method Summary collapse

Methods inherited from BaseProduct

#initialize

Methods included from SubproductMixin

#subproduct

Constructor Details

This class inherits a constructor from Plaid::BaseProduct

Instance Method Details

#update(access_token, webhook) ⇒ Object

Public: Update webhook for an access_token.

Does a POST /item/webhook/update call which is used to update webhook for a particular access_token. Webhooks are used to be notified when transactions for an item are updated and ready.

access_token - The access_token of an item to update webhook for. webhook - The new webhook link.

Returns an UpdateResponse object with either an ItemStatus or MFA response.



155
156
157
158
159
160
 
# File 'lib/plaid/products/item.rb', line 155

def update(access_token, webhook)
  post_with_auth 'item/webhook/update',
                 UpdateResponse,
                 access_token: access_token,
                 webhook: webhook
end