Automations

Subscribe to webhooks

Subscribe to a webhook.

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

Request body

Example request

{
  "webhook": {
    "event_model": "deal",
    "event_action": "create",
    "url": "https://my.app.com/endpoint",
    "failure_email": "fred@bedrock.com"
  }
}

Response

Successful Response

idinteger

Unique identifier

created_atstring

Timestamp when the record was created (time zone in user's time zone).

updated_atstring

Timestamp when the record was last touched (time zone in user's time zone).

namestring

The webhook name.

is_activatedboolean

Indicates whether the webhook is active or not.

account_idinteger

The ID of the account the webhook is associated with.

event_modelstring

The model we are subscribing to (e.g. company, deal, person)

event_actionstring

The event we're subscribing to (e.g. create, update, destroy)

urlstring uri

The url the webhook is to be posted to.

failure_emailstring

The email address to notify when the webhook fails.

Example response

{
  "id": 1,
  "created_at": "2026-09-01 14:22:07",
  "updated_at": "2026-09-01 14:22:07",
  "name": "name",
  "is_activated": true,
  "account_id": 1,
  "event_model": "deal",
  "event_action": "create",
  "url": "https://my.app.com/endpoint",
  "failure_email": "fred@bedrock.com"
}

Changes

No recorded changes to this operation across all 1 revision of this API.