All URIs are relative to https://api.pipedrive.com/v1
| Method | HTTP request | Description |
|---|---|---|
| addWebhook | POST /webhooks | Create a new webhook |
| deleteWebhook | DELETE /webhooks/{id} | Delete existing webhook |
| getWebhooks | GET /webhooks | Get all webhooks |
Webhook addWebhook(subscriptionUrl, eventAction, eventObject, opts)
Create a new webhook
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 <a href="https://pipedrive.readme.io/docs/guide-for-webhooks?ref=api_reference\">https://pipedrive.readme.io/docs/guide-for-webhooks</a> for more details.
import Pipedrive from 'pipedrive';
let defaultClient = Pipedrive.ApiClient.instance;
// Configure API key authorization: api_key
let api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';
let apiInstance = new Pipedrive.WebhooksApi();
let subscriptionUrl = "subscriptionUrl_example"; // String | A full, valid, publicly accessible URL. Determines where to send the notifications. Please note that you cannot use Pipedrive API endpoints as the subscription_url.
let eventAction = "eventAction_example"; // String | Type of action to receive notifications about. Wildcard will match all supported actions.
let eventObject = "eventObject_example"; // String | Type of object to receive notifications about. Wildcard will match all supported objects.
let opts = {
'userId': 56, // Number | 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.
'httpAuthUser': "httpAuthUser_example", // String | HTTP basic auth username of the subscription URL endpoint (if required).
'httpAuthPassword': "httpAuthPassword_example" // String | HTTP basic auth password of the subscription URL endpoint (if required).
};
apiInstance.addWebhook(subscriptionUrl, eventAction, eventObject, opts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});| Name | Type | Description | Notes |
|---|---|---|---|
| subscriptionUrl | String | A full, valid, publicly accessible URL. Determines where to send the notifications. Please note that you cannot use Pipedrive API endpoints as the subscription_url. | |
| eventAction | String | Type of action to receive notifications about. Wildcard will match all supported actions. | |
| eventObject | String | Type of object to receive notifications about. Wildcard will match all supported objects. | |
| userId | Number | 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. | [optional] |
| httpAuthUser | String | HTTP basic auth username of the subscription URL endpoint (if required). | [optional] |
| httpAuthPassword | String | HTTP basic auth password of the subscription URL endpoint (if required). | [optional] |
- Content-Type: application/x-www-form-urlencoded
- Accept: application/json
BaseResponseWithStatus deleteWebhook(id)
Delete existing webhook
Deletes the specified webhook.
import Pipedrive from 'pipedrive';
let defaultClient = Pipedrive.ApiClient.instance;
// Configure API key authorization: api_key
let api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';
let apiInstance = new Pipedrive.WebhooksApi();
let id = 56; // Number | The ID of the webhook to delete
apiInstance.deleteWebhook(id).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});| Name | Type | Description | Notes |
|---|---|---|---|
| id | Number | The ID of the webhook to delete |
- Content-Type: Not defined
- Accept: application/json
Webhooks getWebhooks()
Get all webhooks
Returns data about all webhooks of a company.
import Pipedrive from 'pipedrive';
let defaultClient = Pipedrive.ApiClient.instance;
// Configure API key authorization: api_key
let api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';
// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';
let apiInstance = new Pipedrive.WebhooksApi();
apiInstance.getWebhooks().then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});This endpoint does not need any parameter.
- Content-Type: Not defined
- Accept: application/json