# VyUpdateWebhookRequest

## Properties

| Field                | Type                                                                                                                                     | Description                                                                                                                                                                                                                                            | Required |
| -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------- |
| url                  | string                                                                                                                                   | This is your endpoint URL which can accept \`POST\` calls.                                                                                                                                                                                             | ✗        |
| companyId            | string                                                                                                                                   | Can be obtained from the \[Portal]\(<https://portal.venly.io/>) clicking the❔icon on the top right. Use the \*\*Company ID\*\* when creating webhooks on production env, and use the \*\*Sandbox Company ID\*\* when creating webhooks on sandbox env. | ✗        |
| name                 | string                                                                                                                                   | Any name for the webhook you're about to create.                                                                                                                                                                                                       | ✗        |
| authenticationMethod | [VyWebhookAuthenticationMethodBase](https://sdk.venly.io/sdk-reference/ts-js-v3/object-references/pay/vywebhookauthenticationmethodbase) | This is the type of authentication for your endpoint. Authentication is to be set up by you so you can authenticate the incoming webhooks from Venly. We allow two types: \`BASIC\_AUTHENTICATION\` and \`API\_KEY\`                                   | ✗        |

## References

**Operation**

* [createWebhook](https://sdk.venly.io/sdk-reference/ts-js-v3/function-references/pay/webhooks/createwebhook)
* [updateWebhook](https://sdk.venly.io/sdk-reference/ts-js-v3/function-references/pay/webhooks/updatewebhook)
