URL Expired

The URL for this request expired after 30 days.

bankLinkId

• Type: string
• Required: Yes
• Length: between 1 and 256
• Pattern: ^[a-zA-Z0-9_-]+$

The client-provided identifier of the bank link.

Webhook URL update request

• webhookUrl: uri
  • Required: Yes

The HTTPS URL where webhook events will be delivered.

• accept: string
  • Enum: Defaults to application/json

Generated from available response content types:

• application/json
• application/problem+json

Allowed:

• application/json
• application/problem+json

Responses

200 Webhook URL updated

• type: object

  • status: string
    • Enum: required
    • The webhook update status. Always pending immediately after updating.
      • Example: pending

• message: string

  • Required: Yes
  • Human-readable confirmation message.

• webhookUrl: string

  • Required: Yes

The webhook URL that was requested for update.

Error Responses

• 400: The server cannot or will not process the request due to something that is perceived to be a client error
• 401: Authentication credentials were either missing or incorrect
• 403: Authentication credentials used do not have permissions to perform the request
• 404: The requested resource was not found on the server
• 409: Request conflict with the current state of the target resource
• 500: The server encountered an unexpected condition that prevented it from fulfilling the request

Example Request

curl --request PATCH \
     --url https://api.astrada.co/bank-links/bankLinkId/webhook \
     --header 'accept: application/json' \
     --header 'content-type: application/json'

Example Response

{
  "status": "pending",
  "message": "Webhook update requested. The update will be confirmed when a WEBHOOK_UPDATE_ACKNOWLEDGED webhook is received from Plaid.",
  "webhookUrl": "https://example.com/webhooks/banking"
}