diff --git a/CHANGELOG.md b/CHANGELOG.md index 37f5745a..c237aced 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,10 @@ The file format of it is based on [Keep a Changelog](http://keepachangelog.com/e For public Changelog covering all changes done to Pipedrive’s API, webhooks and app extensions platforms, see [public Changelog](https://pipedrive.readme.io/docs/changelog) with discussion area in [Developers Community](https://devcommunity.pipedrive.com/c/documentation/changelog/19). ## [Unreleased] +### Added +- Documented the `name` property in the Webhooks API for the following endpoints: + - `GET /v1/webhooks` + - `POST /v1/webhooks` ## [29.1.0] - 2025-09-03 ### Added diff --git a/src/versions/v1/models/add-webhook-request.ts b/src/versions/v1/models/add-webhook-request.ts index 9b270aed..480e962f 100644 --- a/src/versions/v1/models/add-webhook-request.ts +++ b/src/versions/v1/models/add-webhook-request.ts @@ -36,6 +36,11 @@ export interface AddWebhookRequest { */ 'event_object': AddWebhookRequestEventObjectConst; /** + * The webhook\'s name + * @type {string} + */ + 'name': string; + /** * The ID of the user that this webhook will be authorized with. You have the option to use a different user\'s `user_id`. If it is not set, the current user\'s `user_id` will be used. As each webhook event is checked against a user\'s permissions, the webhook will only be sent if the user has access to the specified object(s). If you want to receive notifications for all events, please use a top-level admin user’s `user_id`. * @type {number} */ @@ -44,12 +49,12 @@ export interface AddWebhookRequest { * The HTTP basic auth username of the subscription URL endpoint (if required) * @type {string} */ - 'http_auth_user'?: string; + 'http_auth_user'?: string | null; /** * The HTTP basic auth password of the subscription URL endpoint (if required) * @type {string} */ - 'http_auth_password'?: string; + 'http_auth_password'?: string | null; /** * The webhook\'s version. NB! Webhooks v2 is the default from March 17th, 2025. See this Changelog post for more details. * @type {string} diff --git a/src/versions/v1/models/base-webhook.ts b/src/versions/v1/models/base-webhook.ts index 19bdd16e..9d91a712 100644 --- a/src/versions/v1/models/base-webhook.ts +++ b/src/versions/v1/models/base-webhook.ts @@ -56,6 +56,11 @@ export interface BaseWebhook { */ 'subscription_url'?: string; /** + * The Webhook version + * @type {string} + */ + 'version'?: string; + /** * * @type {number} */ @@ -86,11 +91,6 @@ export interface BaseWebhook { */ 'http_auth_password'?: string | null; /** - * Any additional data related to the Webhook - * @type {object} - */ - 'additional_data'?: object; - /** * The removal reason of the Webhook (if removed) * @type {string} */ @@ -110,6 +110,11 @@ export interface BaseWebhook { * @type {number} */ 'admin_id'?: number; + /** + * The Webhook name + * @type {string} + */ + 'name'?: string; } export const BaseWebhookIsActiveConst = {