Sign in

v1

latestOpenAPI 3.0.02026-07-2459256884.4 KB
Partner Webhooks

Update a Webhook

This API allows you to update a specified webhook

patch/v1/partners/webhooks/{webhookId}

Path parameters

webhookIdstring required

Request body

eventType'UPDATE_PLAID_CREDENTIALS' | 'USER_PAYMENT_STATUS' | 'USER_CONNECTION_STATUS' | 'EMPTY_LOAN_ACCOUNT_WEBHOOK' | 'PLATFORM_PAYMENT_STATUS' | 'USER_ACCOUNT_DISCONNECT' | 'USER_LIABILITY_ACCOUNT_TRANSITION' | 'USER_LIABILITY_ACCOUNT_REFRESH' | 'USER_REFINANCE_STATUS' | 'USER_CREDIT_PROFILE_TRANSACTION' | 'USER_CREDIT_PROFILE_TRANSACTION_FAILED' | 'USER_LIABILITIES_CONNECTED' | 'USER_LIABILITIES_CONNECTION_FAILED' | 'REFRESH_TRANSACTION_STATUS' | 'BANK_ACCOUNT_LOOKUP_STATUS_CHANGE' | 'LIABILITY_GROUP_PAYOFF_QUOTE_STATUS_CHANGE' | 'STATEMENT_SUMMARY_NOTIFICATION' | 'NEW_LIABILITIES_REPORTED' | 'SUBSCRIPTION_ACTIVATED' | 'SUBSCRIPTION_FAILED'

The event type which triggers the webhook

urlstring required

Partner provided webhook URL

Example request

{
  "eventType": "USER_PAYMENT_STATUS",
  "url": "http://localhost:8000/paymentStatusWebhook",
  "headers": [
    {
      "name": "Authorization",
      "value": "Bearer token"
    }
  ]
}

Response

Successful response

Example response

{
  "status": {
    "code": 200,
    "desc": "success",
    "messages": [
      {
        "desc": "Example description"
      }
    ]
  },
  "data": {
    "isEnabled": true,
    "webhookId": "067f4179-6be6-4c50-9933-89893b979f06",
    "eventType": "USER_PAYMENT_STATUS",
    "url": "http://localhost:8000/paymentStatusWebhook",
    "headers": [
      {
        "name": "Authorization",
        "value": "Bearer token"
      }
    ]
  }
}