This page describes the webhook events your system receives when customer notes are created, updated, or deleted via the Public API
Use these events to:
- Track note lifecycle changes
- Sync note data with external systems
- Update customer records in CRM systems
- Trigger notifications or workflows
- Maintain audit trails
When are webhooks sent?
A webhook is sent every time a note is created, updated, or deleted through the Public API. Each event corresponds to a single note operation.
Event types
| Event | Description |
|---|---|
CUSTOMER_NOTE_CREATED | A new customer note was created |
CUSTOMER_NOTE_UPDATED | An existing customer note was updated |
CUSTOMER_NOTE_DELETED | A customer note was deleted |
Webhook payload
All note events follow the same base structure. The payload includes an event field that identifies the type of operation.
| Field | Type | Description |
|---|---|---|
event | string | Event type:"note-created", "note-updated", or "note-deleted" |
noteId | string | Unique identifier of the note (UUID) |
wabaNumber | string | WhatsApp Business Account phone number (with country code, no leading +) |
customerPhone | string | Customer phone number (with country code) |
customerName | string | Customer display name |
note | string | Text content of the note |
createdByAgent | string | Name of the agent who created the note (present in CREATED event) |
createdByAgentNumber | string | Phone number of the agent who created the note (present in CREATED event) |
createdAt | string | ISO timestamp when note was created (present in CREATED event) |
updatedByAgent | string | Name of the agent who updated the note (present in UPDATED event) |
updatedByAgentNumber | string | Phone number of the agent who updated the note (present in UPDATED event) |
updatedAt | string | ISO timestamp when note was last updated (present in UPDATED event) |
deletedByAgent | string | Name of the agent who deleted the note (present in DELETED event) |
deletedByAgentNumber | string | Phone number of the agent who deleted the note (present in DELETED event) |
deletedAt | string | ISO timestamp when note was deleted (present in DELETED event) |
Sample payloads
Note created
{
"event": "note-created",
"noteId": "c2973bf3-5f7a-4f30-a927-57cfb0c66ad3",
"wabaNumber": "918655606643",
"customerPhone": "+919392791677",
"customerName": "John Doe",
"note": "Spoke with customer, follow-up demo scheduled for tomorrow.",
"createdByAgent": "Mitul Varshney",
"createdByAgentNumber": "+919999999999",
"createdAt": "2026-02-06T11:55:03.170Z"
}
Note updated
{
"event": "note-updated",
"noteId": "c2973bf3-5f7a-4f30-a927-57cfb0c66ad3",
"wabaNumber": "918655606643",
"customerPhone": "+919392791677",
"customerName": "John Doe",
"note": "Updated: Spoke with customer, follow-up demo scheduled for tomorrow. Confirmed time: 2 PM.",
"updatedByAgent": "Mitul Varshney",
"updatedByAgentNumber": "+919999999999",
"updatedAt": "2026-02-06T12:30:15.450Z"
}
Note deleted
{
"event": "note-deleted",
"noteId": "c2973bf3-5f7a-4f30-a927-57cfb0c66ad3",
"wabaNumber": "918655606643",
"customerPhone": "+919392791677",
"customerName": "John Doe",
"note": "Spoke with customer, follow-up demo scheduled for tomorrow.",
"deletedByAgent": "Mitul Varshney",
"deletedByAgentNumber": "+919999999999",
"deletedAt": "2026-02-06T13:15:22.789Z"
}
Important notes
-
Event field: The
eventfield is always present and indicates the operation type (note-created,note-updated, ornote-deleted). -
Event-specific fields: Each event type includes only the relevant fields:
- CREATED events include
createdByAgent,createdByAgentNumber, andcreatedAt - UPDATED events include
updatedByAgent,updatedByAgentNumber, andupdatedAt - DELETED events include
deletedByAgent,deletedByAgentNumber, anddeletedAt
- CREATED events include
-
Note content: The
notefield contains the current text content at the time of the event. For DELETE events, it contains the note content before deletion. -
Agent information: Agent names and phone numbers are provided for all operations. The agent phone number format matches the customer phone number format (with country code).
-
WABA number: The
wabaNumberfield identifies the WhatsApp Business Account associated with the note. -
Customer identification: The
customerPhoneandcustomerNamefields help identify the customer in your system. The phone number includes the country code.
Related endpoints
These webhooks are triggered by the following Public API endpoints:
POST /v2/p/notes- Creates a note (triggersCUSTOMER_NOTE_CREATED)PATCH /v2/p/notes- Updates a note (triggersCUSTOMER_NOTE_UPDATED)DELETE /v2/p/notes- Deletes a note (triggersCUSTOMER_NOTE_DELETED)
Webhook registration
To receive these webhooks, register your webhook URL using the Public API:
POST /v2/p/webhook/register
Include CUSTOMER_NOTE_CREATED, CUSTOMER_NOTE_UPDATED, and CUSTOMER_NOTE_DELETED in the webhookEvents array.
