---
title: "Subscribe to webhooks"
method: POST
path: "/admin/webhooks"
tags: ["Automations"]
---

# Subscribe to webhooks

`POST /admin/webhooks`

## Request

- Base URL: `https://api.pipelinecrm.com/api/v3`
- URL: `https://api.pipelinecrm.com/api/v3/admin/webhooks`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer and API key in header `app-key`
  - API key in query parameter `api_key` and API key in query parameter `app_key`

Subscribe to a webhook.

## Request body

- object
  - `webhook` WebhookWritable
    - `event_model` string: The model we are subscribing to (e.g. company, deal, person)
    - `event_action` string: The event we're subscribing to (e.g. create, update, destroy)
    - `url` string, uri: The url the webhook is to be posted to.
    - `failure_email` string: The email address to notify when the webhook fails.

## Response `200`

Successful Response

- WebhookAll
  - `id` integer: Unique identifier
  - `created_at` string: Timestamp when the record was created (time zone in user's time zone).
  - `updated_at` string: Timestamp when the record was last touched (time zone in user's time zone).
  - `name` string: The webhook name.
  - `is_activated` boolean: Indicates whether the webhook is active or not.
  - `account_id` integer: The ID of the account the webhook is associated with.
  - `event_model` string: The model we are subscribing to (e.g. company, deal, person)
  - `event_action` string: The event we're subscribing to (e.g. create, update, destroy)
  - `url` string, uri: The url the webhook is to be posted to.
  - `failure_email` string: The email address to notify when the webhook fails.

## Other responses

- `401`: Missing, invalid, expired or revoked credentials.
- `403`: The credentials are valid but this user may not perform the action (permissions, a read-only token, or API access switched off).

---

[API](https://skmtc.dev/pipelinecrm/apis/pipeline-crm-api.md) · [All operations](https://skmtc.dev/pipelinecrm/apis/pipeline-crm-api/llms.txt) · [OpenAPI document](https://skmtc.dev/pipelinecrm/apis/pipeline-crm-api/revisions/53ebfcc83597?raw)