Skip to content
API PlatformDevelopers

Webhook events · conversations

conversation.mention.created/1

Staff member mentioned. A staff member was @-mentioned in a conversation (in the app, or by a note with mentions through the API). One event per person mentioned. The note text is not included.

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.mention.created
versionrequiredstringPayload version.always 1
api_versionrequiredstringThe endpoint's API version.
occurred_atrequiredstringWhen it happened.date-time
company_idrequiredintegerYour workspace id.
datarequiredobject
idrequiredintegerMention id.
conversationrequiredobject
idrequiredintegerConversation id.
company_idrequiredintegerWorkspace id.
by_staffobject or nullWho mentioned them.
idrequiredintegerId.
namerequiredstring or nullName.
mentioned_staffrequiredobject or nullWho was mentioned.
idrequiredintegerId.
namerequiredstring or nullName.
acknowledged_atstring or nullISO 8601; null until they acknowledge it.

Example

{
  "id": "evt_01J8Z7BZQ4F6G8J2K5N7Q9S1VC",
  "type": "conversation.mention.created",
  "version": "1",
  "api_version": "2026-10-01",
  "occurred_at": "2026-09-24T09:20:00Z",
  "company_id": 1001,
  "data": {
    "id": 778899,
    "conversation": {
      "id": 77410,
      "company_id": 1001
    },
    "by_staff": {
      "id": 1204,
      "name": "Daniel Park"
    },
    "mentioned_staff": {
      "id": 1203,
      "name": "Priya Nair"
    },
    "acknowledged_at": null
  }
}

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