Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
9 changes: 7 additions & 2 deletions src/versions/v1/models/add-webhook-request.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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}
*/
Expand All @@ -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 <a href=\"https://developers.pipedrive.com/changelog/post/breaking-change-webhooks-v2-will-become-the-new-default-version\" target=\"_blank\" rel=\"noopener noreferrer\">this Changelog post</a> for more details.
* @type {string}
Expand Down
15 changes: 10 additions & 5 deletions src/versions/v1/models/base-webhook.ts
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,11 @@ export interface BaseWebhook {
*/
'subscription_url'?: string;
/**
* The Webhook version
* @type {string}
*/
'version'?: string;
/**
*
* @type {number}
*/
Expand Down Expand Up @@ -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}
*/
Expand All @@ -110,6 +110,11 @@ export interface BaseWebhook {
* @type {number}
*/
'admin_id'?: number;
/**
* The Webhook name
* @type {string}
*/
'name'?: string;
}

export const BaseWebhookIsActiveConst = {
Expand Down
Loading