For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Help CenterAPI KeysStatusSign In
GuidesAPI ReferenceChangelog
GuidesAPI ReferenceChangelog
  • Getting started
    • Overview
    • Quickstart
    • Authentication
    • Rate limits
  • Messaging API
    • Send transactional email
    • Send transactional SMS
    • Send transactional WhatsApp
  • Marketing Platform
    • Manage your contacts
    • Track website activity
    • Send WhatsApp campaigns
    • Weekly event exports
  • Webhooks
    • Getting started
    • Conversations webhooks
    • Payment webhooks
    • Marketing webhooks
    • Transactional webhooks
    • Loyalty webhooks
    • Batched webhooks
    • Secure webhook calls
    • Meetings and phone webhooks
    • Push notification webhooks
    • Sales CRM webhooks
  • Conversations
    • Getting started
    • Customize the chat widget
    • JavaScript API reference
    • REST API reference
    • Conversations webhooks
  • eCommerce
    • Activate eCommerce app
    • Manage product categories
    • Manage products
    • Manage orders
    • Coupon collections
    • eCommerce tracker events
  • Loyalty
    • Overview
    • Set up a program
    • Enroll members
    • Credit & debit points
    • Read member data
    • Best practices
  • Custom Objects
    • Custom objects management
  • Brevo tracker and events
    • Getting started
    • JavaScript implementation
    • REST implementation
    • Legacy tracker documentation
    • Events
  • Accounts and settings
    • Senders and domains
    • User activity logs
    • External feeds
    • Invited users
LogoLogo
Help CenterAPI KeysStatusSign In
On this page
  • Deals webhook events
  • Task completed
  • Task created
  • Deal stage updated
  • Deal created
  • Deal attributes updated
  • Deal association updated
Webhooks

Sales CRM webhooks

Was this page helpful?
Previous

Getting started

Next
Built with

This page lists the currently supported Sales webhook events and their payloads.

Deals webhook events

  • Task completed
  • Task created
  • Deal stage updated
  • Deal created
  • Deal attributes updated
  • Deal association updated

Deals webhook events

Task completed

Attribute nameDatatypeDescription
completion_dateStringTask completion date
due_dateStringDue date of task
nameStringName of the task
taskTypeStringType of task
taskTypeIdStringTask type ID
task_idStringTask ID
1{
2 "completion_date": "2025-06-10T07:09:01.696Z",
3 "due_date": "2025-06-10T07:09:01.696Z",
4 "name": "Reportingtask",
5 "taskType": "Reporting",
6 "taskTypeId": "5f000878-0070-4b1c-8931-2c8004cf00da",
7 "task_id": "844xx18c-f4ec-480e-xxde-9df8xxa3xxde"
8}

Task created

Attribute nameDatatypeDescription
assign_toStringIndicates who the task is assigned to
due_dateStringDue date of the task
nameStringName of the task
priorityBoolIndicates if task is priority or not; True for priority task
taskTypeStringTask type
taskTypeIdStringTask type ID
1{
2 "assign_to": "Assignee",
3 "due_date": "2025-06-10T07:09:01.696Z",
4 "name": "Reportingtask",
5 "priority": true,
6 "taskType": "5f000878-0070-4b1c-8931-2c8004cf00da",
7 "taskTypeId": "844xx18c-f4ec-480e-xxde-9df8xxa3xxde"
8}

Deal stage updated

Attribute nameDatatypeDescription
amountNumericAmount associated with deal
deal_idStringDeal ID
deal_nameStringDeal name
lost_reasonStringReason for loss of deal
pipeline_idStringPipeline ID
pipeline_nameStringPipeline name
stage_idStringStage ID
stage_nameStringStage name
1{
2 "amount": 750,
3 "deal_id": "0d000913-009f-4d86-00f9-002580002511",
4 "deal_name": "Deal123",
5 "lost_reason": "Budget constraint",
6 "pipeline_id": "bxxd35ef-c0f0-41e8-xx8a-7f820004bd57",
7 "pipeline_name": "Pipeline123",
8 "stage_id": "49xx7da7-axxd-4b72-xx6a-93b1dxxxcc25",
9 "stage_name": "Negotiation"
10}

Deal created

Attribute nameDatatypeDescription
amountNumericAmount associated with deal
deal_idStringDeal ID
deal_nameStringDeal name
lost_reasonStringReason for loss of deal
pipeline_idStringPipeline ID
pipeline_nameStringPipeline name
stage_idStringStage ID
stage_nameStringStage name
1{
2 "amount": 750,
3 "deal_id": "0d000913-009f-4d86-00f9-002580002511",
4 "deal_name": "Deal123",
5 "lost_reason": "Budget constraint",
6 "pipeline_id": "bxxd35ef-c0f0-41e8-xx8a-7f820004bd57",
7 "pipeline_name": "Pipeline123",
8 "stage_id": "49xx7da7-axxd-4b72-xx6a-93b1dxxxcc25",
9 "stage_name": "Negotiation"
10}

Deal attributes updated

Attribute nameDatatypeDescription
amountNumericAmount associated with deal
deal_idStringDeal ID
deal_nameStringDeal name
lost_reasonStringReason for loss of deal
pipeline_idStringPipeline ID
pipeline_nameStringPipeline name
stage_idStringStage ID
stage_nameStringStage name
1{
2 "amount": 750,
3 "deal_id": "0d000913-009f-4d86-00f9-002580002511",
4 "deal_name": "Deal123",
5 "lost_reason": "Budget constraint",
6 "pipeline_id": "bxxd35ef-c0f0-41e8-xx8a-7f820004bd57",
7 "pipeline_name": "Pipeline123",
8 "stage_id": "49xx7da7-axxd-4b72-xx6a-93b1dxxxcc25",
9 "stage_name": "Negotiation"
10}

Deal association updated

Attribute nameDatatypeDescription
amountNumericAmount associated with deal
deal_idStringDeal ID
deal_nameStringDeal name
lost_reasonStringReason for loss of deal
pipeline_idStringPipeline ID
pipeline_nameStringPipeline name
stage_idStringStage ID
stage_nameStringStage name
associated_entity_typeStringType of associated entity; either contact or company
link_idsArrayIDs of entities linked to the deal
unlink_idsArrayIDs of entities unlinked from the deal
1{
2 "amount": 750,
3 "deal_id": "0d000913-009f-4d86-00f9-002580002511",
4 "deal_name": "Deal123",
5 "lost_reason": "Budget constraint",
6 "pipeline_id": "bxxd35ef-c0f0-41e8-xx8a-7f820004bd57",
7 "pipeline_name": "Pipeline123",
8 "stage_id": "49xx7da7-axxd-4b72-xx6a-93b1dxxxcc25",
9 "stage_name": "Negotiation",
10 "associated_entity_type": "contact",
11 "link_ids": ["3", "42"],
12 "unlink_ids": ["15"]
13}