POST /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, create.deal for any newly added deals, delete.persons for any deleted persons, etc. See the guide for Webhooks for more details.
Servers
- https://api.pipedrive.com/v1
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
event_object |
String | Yes |
The type of object to receive notifications about. Wildcard will match all supported objects. Possible values:
|
subscription_url |
String | Yes |
A full, valid, publicly accessible URL which determines where to send the notifications. Please note that you cannot use Pipedrive API endpoints as the |
version |
String | No |
The webhook's version. NB! Webhooks v2 is the default from March 17th, 2025. See this Changelog post for more details. Possible values:
Default value: "2.0" |
event_action |
String | Yes |
The type of action to receive notifications about. Wildcard will match all supported actions. Possible values:
|
http_auth_user |
String | No |
The HTTP basic auth username of the subscription URL endpoint (if required) |
http_auth_password |
String | No |
The HTTP basic auth password of the subscription URL endpoint (if required) |
user_id |
Integer | No |
The ID of the user that this webhook will be authorized with. You have the option to use a different user's |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.