Webhooks
See the guide for Webhooks for more information.
Get all Webhooks
/v1/webhooks
Returns data about all the Webhooks of a company.
Response
The list of webhooks objects from the logged in company and user
Expand all
Copy code- "ok"
- true
- [ ... ]▶
Create a new Webhook
/v1/webhooks
Creates a new Webhook and returns its details. Note that specifying an event which triggers the Webhook combines 2 parameters - event_action and event_object. E.g., use *.* for getting notifications about all events, added.deal for any newly added deals, deleted.persons for any deleted persons, etc. See the guide for Webhooks for more details.
Body parameters
application/json
subscription_url
string
required
A full, valid, publicly accessible URL which determines where to send the notifications. Please note that you cannot use Pipedrive API endpoints as the subscription_url and the chosen URL must not redirect to another link.
event_action
string
required
The type of action to receive notifications about. Wildcard will match all supported actions.
Values
added
updated
merged
deleted
*
event_object
string
required
The type of object to receive notifications about. Wildcard will match all supported objects.
Values
activity
activityType
deal
note
organization
person
pipeline
product
stage
user
*
user_id
integer
The ID of the user this Webhook will be authorized with. If not set, current authorized user will be used. Note that this does not filter only certain user's events — rather, this specifies the user's permissions under which each event is checked. Events about objects the selected user is not entitled to access are not sent. If you want to receive notifications for all events, a top-level admin user should be used.
http_auth_user
string
The HTTP basic auth username of the subscription URL endpoint (if required)
http_auth_password
string
The HTTP basic auth password of the subscription URL endpoint (if required)
Response
The created webhook object
Expand allCopy code- "ok"
- true
- { ... }▶
Delete existing Webhook
/v1/webhooks/{id}
Deletes the specified Webhook.
Path parameters
id
integer
required
The ID of the Webhook to delete
Response
The webhook deletion success response
Expand allCopy code- "ok"
- true