Skip to content

Commit 7c9582f

Browse files
authored
Update README.md
1 parent 23ddf61 commit 7c9582f

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -227,9 +227,9 @@ pipedrive.Filters.getAll({ type: 'deals' }, function(filtersListErr, filtersList
227227
});
228228
```
229229

230-
# Ad hoc data change event listeneres
230+
# Ad hoc data change event listeneres (beta)
231231

232-
The API client lets you create event listeners to specific data changes in your Pipedrive account. This is very similar to Web Hooks, except the listeners are bound on an ad hoc basis and will only be executed during the lifecycle of your application. For example (see below) you may want to execute a callback every time a new deal is added to Pipedrive. Note that this callback will execute not only when you create the deal through this API client but regardless of where the deal was added from — a mobile app, the web app or through the Pipedrive API by some other integration.
232+
The API client lets you create event listeners to specific data changes in your Pipedrive account. This is very similar to Webhooks, except the listeners are bound on an ad hoc basis and will only be executed during the lifecycle of your application. For example (see below) you may want to execute a callback every time a new deal is added to Pipedrive. Note that this callback will execute not only when you create the deal through this API client but regardless of where the deal was added from — a mobile app, the web app or through the Pipedrive API by some other integration.
233233

234234
```js
235235
var Pipedrive = require('pipedrive');
@@ -240,6 +240,8 @@ pipedrive.on('deal.added', function(event, data) {
240240
});
241241
```
242242

243+
Supported event names consist of object type (deal, person, organization, ...) and type of change (`added`, `deleted`, `updated` or `merged`), joined by a dot. The list of supported object types are listed in the [Pipedrive Webhooks documentation](https://app.pipedrive.com/webhooks).
244+
243245
To read more about ad hoc data change event listeners, check out [examples/live-updates.js](examples/live-updates.js).
244246

245247
# API Documentation

0 commit comments

Comments
 (0)