Webhooks

See https://pipedrive.readme.io/docs/guide-for-webhooks for more info about webhooks.

Get all webhooks

Copy link
Copy to clipboard
GET

/v1/webhooks

Returns data about all webhooks of a company.

Response
200

The list of webhooks objects from the logged in company and user

Expand all
Copy code
    • "ok"
    • true
    • [ ... ]

    Create a new webhook

    Copy link
    Copy to clipboard
    POST

    /v1/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, added.deal for any newly added deals, deleted.persons for any deleted persons, etc. See https://pipedrive.readme.io/docs/guide-for-webhooks for more details.

    Body parameters

    application/json

    subscription_url

    string

    required

    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

    string

    required

    Type of action to receive notifications about. Wildcard will match all supported actions.

    Values

    added

    updated

    merged

    deleted

    *

    event_object

    string

    required

    Type of object to receive notifications about. Wildcard will match all supported objects.

    Values

    activity

    activityType

    deal

    note

    organization

    person

    pipeline

    product

    stage

    user

    *

    user_id

    integer

    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.

    http_auth_user

    string

    HTTP basic auth username of the subscription URL endpoint (if required).

    http_auth_password

    string

    HTTP basic auth password of the subscription URL endpoint (if required).

    Response
    201

    The created webhook object

    Expand all
    Copy code
      • "ok"
      • true
      • { ... }

      Delete existing webhook

      Copy link
      Copy to clipboard
      DELETE

      /v1/webhooks/{id}

      Deletes the specified webhook.

      Path parameters

      id

      integer

      required

      The ID of the webhook to delete

      Response
      200

      The webhook deletion success response

      Expand all
      Copy code
        • "ok"
        • true

      Subscribe to Pipedrive’s Developer Newsletter