Skip to content
API PlatformDevelopers

Webhook events · conversations

conversation.note.created/1

Internal note added. A staff member (or the API) added an internal note. Notes are never shown to the customer.

Payload

We POST this JSON to your endpoint. Answer any 2xx within 30 seconds. The same id arrives again on a retry — skip ones you have handled.

Payload fields
FieldTypeWhat it is
idrequiredstringEvent id. The same on every retry: use it to skip duplicates.pattern ^evt_[0-9A-HJKMNP-TV-Z]{26}$
typerequiredstringEvent type.always conversation.note.created
versionrequiredstringPayload version.always 1
api_versionrequiredstringThe endpoint's API version.
occurred_atrequiredstringWhen it happened.date-time
company_idrequiredintegerYour workspace id.
datarequiredobject
idrequiredintegerNote id.
conversationrequiredobject
idrequiredintegerConversation id.
company_idrequiredintegerWorkspace id.
staffobject or nullWho wrote it.
idrequiredintegerId.
namerequiredstring or nullName.
bodyrequiredstringThe note text.
created_atstring or nullISO 8601.

Example

{
  "id": "evt_01J8Z7BZQ4F6G8J2K5N7Q9S1VC",
  "type": "conversation.note.created",
  "version": "1",
  "api_version": "2026-10-01",
  "occurred_at": "2026-09-24T09:20:00Z",
  "company_id": 1001,
  "data": {
    "id": 90331,
    "conversation": {
      "id": 77410,
      "company_id": 1001
    },
    "staff": {
      "id": 1203,
      "name": "Priya Nair"
    },
    "body": "Customer asked for a refund; ticket #4411.",
    "created_at": "2026-09-24T09:20:00Z"
  }
}

Headers

  • Webhook-Signature: t=…,v1=… — how to check it
  • Webhook-Id (also Webhook-Event-Id): the event id, the same on every retry — skip ones you have handled
  • Webhook-Delivery-Id: this delivery attempt, new on every try

API calls that can cause it