Webhooks

See the guide for Webhooks for more information.

Get all Webhooks

Copy link
Copy to clipboard
GET

/v1/webhooks

Returns data about all the Webhooks of a company.

Response
200

OK

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 the guide for Webhooks for more details.

    Body parameters

    application/json

    subscription_url

    string

    required

    A full, valid, publicly accessible URL which determines where to send the notifications. Please note that you cannot use Pipedrive API endpoints as the subscription_url and the chosen URL must not redirect to another link.

    event_action

    string

    required

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

    Values

    added

    updated

    merged

    deleted

    *

    event_object

    string

    required

    The 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 that this webhook will be authorized with. You have the option to use a different user's user_id. If it is not set, the current user's user_id will be used. As each webhook event is checked against a user’s permissions, the webhook will only be sent if the user has access to the specified object(s). If you want to receive notifications for all events, please use a top-level admin user’s user_id.

    http_auth_user

    string

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

    http_auth_password

    string

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

    Response
    201

    Created

    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

      OK

      Expand all
      Copy code
        • "ok"
        • true

      Subscribe to Pipedrive’s Developer Newsletter