webhooks.add: Create a new webhook

In Rpipedrive: 'Pipedrive API's' Functions to Improvement and Integration's Systems

Description

Function to Create a new webhook on pipedrive.

Usage

webhooks.add(subscription_url, event_action, event_object,
  user_id = NULL, http_auth_user = NULL, http_auth_password = NULL,
  api_token = NULL, company_domain = "api",
  return_type = c("complete", "boolean"))

Arguments

subscription_url	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.
event_action	Type of action to receive notifications about. Wildcard will match all supported actions. This field has the following domains: (added; updated; merged; deleted; *)
event_object	Type of object to receive notifications about. Wildcard will match all supported objects. This field has the following domains: (activity; activityType; deal; note; organization; person; pipeline; product; stage; user; *)
user_id	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	HTTP basic auth username of the subscription URL endpoint (if required).
http_auth_password	HTTP basic auth password of the subscription URL endpoint (if required).
api_token	To validate your requests, you'll need your api_token - this means that our system will need to know who you are and be able to connect all actions you do with your chosen Pipedrive account. Have in mind that a user has a different api_token for each company. Please access the following link for more information: <https://pipedrive.readme.io/docs/how-to-find-the-api-token?utm_source=api_reference>
company_domain	How to get the company domain: <https://pipedrive.readme.io/docs/how-to-get-the-company-domain>
return_type	the default return is an object List with all informations of process, or you can set boolean (TRUE = success, FALSE = error)

Value

customizable return, the default is an object List

Examples

webhooks.add(subscription_url='e.g.',event_action='e.g.',event_object='e.g.')

Rpipedrive documentation built on May 15, 2019, 1:06 a.m.