---
title: "Create a new Webhook"
method: POST
path: "/webhooks"
tags: ["Webhooks"]
---

# Create a new Webhook

`POST /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, `create.deal` for any newly added deals, `delete.persons` for any deleted persons, etc. See <a href="https://pipedrive.readme.io/docs/guide-for-webhooks-v2?ref=api_reference" target="_blank" rel="noopener noreferrer">the guide for Webhooks</a> for more details.

## Request body

- object
  - `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` 'create' | 'change' | 'delete' | '*', required — The type of action to receive notifications about. Wildcard will match all supported actions.
  - `event_object` 'activity' | 'deal' | 'lead' | 'note' | 'organization' | 'person' | 'pipeline' | 'product' | 'stage' | 'user' | '*', required — The type of object to receive notifications about. Wildcard will match all supported objects.
  - `name` string, required — The webhook's name
  - `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, nullable — The HTTP basic auth username of the subscription URL endpoint (if required)
  - `http_auth_password` string, nullable — The HTTP basic auth password of the subscription URL endpoint (if required)
  - `version` '1.0' | '2.0' — The webhook's version. NB! Webhooks v2 is the default from March 17th, 2025. See <a href="https://developers.pipedrive.com/changelog/post/breaking-change-webhooks-v2-will-become-the-new-default-version" target="_blank" rel="noopener noreferrer">this Changelog post</a> for more details.

## Response `201`

The created webhook object

- object
  - `success` boolean — If the response is successful or not
  - `status` string — The status of the response
  - `data` object
    - `id` integer — The ID of the Webhook
    - `company_id` integer — The ID of the company related to the Webhook
    - `owner_id` integer — The ID of the user who owns the Webhook
    - `user_id` integer — The ID of the user related to the Webhook
    - `event_action` string — The Webhook action
    - `event_object` string — The Webhook object
    - `subscription_url` string — The subscription URL of the Webhook
    - `version` string — The Webhook version
    - `is_active` 0 | 1 — The Webhook's status
    - `add_time` string, date-time — The date when the Webhook was added
    - `remove_time` string, date-time, nullable — The date when the Webhook was removed (if removed)
    - `type` 'general' | 'application' | 'automation' — The type of the Webhook
    - `http_auth_user` string, nullable — The username of the `subscription_url` of the Webhook
    - `http_auth_password` string, nullable — The password of the `subscription_url` of the Webhook
    - `remove_reason` string, nullable — The removal reason of the Webhook (if removed)
    - `last_delivery_time` string, date-time, nullable — The last delivery time of the Webhook
    - `last_http_status` integer, nullable — The last delivery HTTP status of the Webhook
    - `admin_id` integer — The ID of the admin of the Webhook
    - `name` string — The Webhook name

## Other responses

- `400` — The bad response on webhook creation
- `401` — Unauthorized response

---

[API](https://skmtc.net/pipedrive/apis/pipedrive-api-v1.md) · [All operations](https://skmtc.net/pipedrive/apis/pipedrive-api-v1/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pipedrive/pipedrive-api-v1/versions/bf863a979545/schema)