Plaid.Sandbox.fire_item_webhook
You're seeing just the function
fire_item_webhook
, go back to Plaid.Sandbox module for more information.
Specs
fire_item_webhook(String.t(), String.t(), Plaid.config()) :: {:ok, Plaid.Sandbox.FireItemWebhookResponse.t()} | {:error, Plaid.Error.t()}
Fire a fake webhook to an Item's webhook endpoint.
Does a POST /sandbox/item/fire_webhook
call which forces an item into the
ITEM_LOGIN_REQUIRED state to simulate and item whose login is no longer valid.
Params:
access_token
- The access token associated with the Item to fire the webhook for.webhook_code
- The webhook code to send.
webhook_code
only supportsDEFAULT_UPDATE
for now.
Examples
Sandbox.fire_item_webhook("access-prod-123xxx", "DEFAULT_UPDATE", client_id: "123", secret: "abc")
{:ok, %Sandbox.FireItemWebhookResponse{}}