---
title: "partner/webhook-url"
method: POST
path: "/partner/webhook-url"
tags: ["Webhook Endpoints"]
---

# partner/webhook-url

`POST /partner/webhook-url`

## Request

- Base URL: `https://earthnode-dev.vopay.com/api/v2`
- URL: `https://earthnode-dev.vopay.com/api/v2/partner/webhook-url`
- Auth: none declared

This endpoint will allow the user to modify the webhook URL.

The purpose of the webhook URL is to notify users of any changes in the status of the accounts you create.

## Request body `application/x-www-form-urlencoded`

- object
  - `AccountID` string, required: Your account ID
  - `Key` string, required: API key for the account
  - `Signature` string, required: Hashed signature for the request
  - `WebHookUrl` string: URL where the users want us to send their notifications. This parameter has to be a valid URL. If the field Disabled is added, this field can be optional; otherwise, it will consider as mandatory
  - `Type` string: The type of webhook notification the users wish to receive. Options are: transaction, paylink, bankaccount, debitcard, creditcard, batchrequest, batchdetail, accountonboarding, accountonboardingapplication, scheduledtransactions, accountverifications, virtualtransaction. If left blank it will apply to all types.
  - `Disabled` boolean: If this parameter is present WebHookUrl is not mandatory.

## Response `200`

- object
  - `Success` boolean, required: True if the request was successful, false if it failed
  - `ErrorMessage` string, required: Contains a description of the error if the request failed

---

[API](https://skmtc.dev/vopay/apis/integrations-and-support.md) - [All operations](https://skmtc.dev/vopay/apis/integrations-and-support/llms.txt) - [OpenAPI document](https://skmtc.dev/vopay/apis/integrations-and-support/revisions/e88c512ce5f0?raw)