ASP.NET Web API Help Page

POST Vendors/Plaid/receive-webhook

Receives a web-hook from Plaid.

Request Information

URI Parameters

None.

Body Parameters

Asset webhook generation status.

Name	Type	Additional information
asset_report_id	string	None.
error	Plaid.Error	None.
webhook_code	string	None.
webhook_type	string	None.

Request Formats

application/json, text/json

Sample:

{
  "asset_report_id": "sample String 1",
  "error": {
    "display_message": "sample String 1",
    "request_id": "sample String 2",
    "causes": [
      "sample String 1",
      "sample String 2"
    ],
    "documentation_url": "http://webapihelppage3.com",
    "error_code": "sample String 4",
    "error_message": "sample String 5",
    "status": 1,
    "suggested_action": "sample String 6"
  },
  "webhook_code": "sample String 2",
  "webhook_type": "sample String 3"
}

text/html

Sample:

{"asset_report_id":"sample String 1","error":{"display_message":"sample String 1","request_id":"sample String 2","causes":["sample String 1","sample String 2"],"documentation_url":"http://webapihelppage3.com","error_code":"sample String 4","error_message":"sample String 5","status":1,"suggested_action":"sample String 6"},"webhook_code":"sample String 2","webhook_type":"sample String 3"}

application/xml, text/xml

Sample:

<WebHook xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <AssetReportId>sample String 1</AssetReportId>
  <Error>
    <DisplayMessage>sample String 1</DisplayMessage>
    <RequestId>sample String 2</RequestId>
    <Causes>sample String 1</Causes>
    <Causes>sample String 2</Causes>
    <ErrorCode>sample String 4</ErrorCode>
    <ErrorMessage>sample String 5</ErrorMessage>
    <Status>1</Status>
    <SuggestedAction>sample String 6</SuggestedAction>
  </Error>
  <WebhookCode>sample String 2</WebhookCode>
  <WebhookType>sample String 3</WebhookType>
</WebHook>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The response.

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.