Commit e3220a3e by AdriVanHoudt

updated the docs to add webhook stuff

parent 5d9452f1
......@@ -119,17 +119,18 @@ fullcontact.location.enrich('denver', function (err, data) {
### Person
The `Person` endpoint is confidently namespaced as a `.person` property. Each
person API has an optional `queue` argument which you can use to indicate that
The `Person` endpoint is confidently namespaced as a `.person` property.
Each person API has an optional `queue` argument which you can use to indicate that
this request will should be pre-processed by FullContact and that you want to
fetch the details later. According to the API it should to receive the value `1`
as queue.
The following methods are available on this API:
#### person.email(address, [queue], fn);
#### person.email(address, [queue], [webhookUrl], [webhookId], fn);
Retrieves contact information by e-mail address.
Supports the use of webhooks by providing an url and id.
```js
fullcontact.person.email('foo@bar.com', function (err, data) {
......@@ -137,6 +138,12 @@ fullcontact.person.email('foo@bar.com', function (err, data) {
});
```
```js
fullcontact.person.email('foo@bar.com', null, 'https://mycallbackurl.com', 'webhooktracker', function (err, data) {
..
});
```
#### person.md5(address, [queue], fn);
Retrieves contact information by e-mail address but transforms the email to an
......
......@@ -18,7 +18,7 @@ function Person(api) {
* Retrieve contact information by e-mail.
*
* ```js
* fullcontact.person.email('opensource@observe.it', [queue], fn);
* fullcontact.person.email('opensource@observe.it', [queue], [webhookUrl], [webhookId], fn);
* ```
*
* @returns {Person}
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment