inbox.thread.labels.updated

{
  "type": "inbox.thread.labels.updated",
  "created_at": "2026-09-29T12:00:00.000Z",
  "data": {
    "added": [
      {
        "id": "c0a8012e-3b4f-4d7a-9e21-5f6a7b8c9d0e",
        "name": "Billing",
        "color": "#F76B15"
      }
    ],
    "removed": [],
    "source": "dashboard",
    "inbox_id": "b3e2b2b6-3f0e-4c8e-9ad3-2f43a1e2c7f1",
    "thread_id": "7c1f0a2e-5d3b-4e8a-9f61-2b8d4c6e1a90",
    "thread": {
      "object": "inbox_thread",
      "id": "7c1f0a2e-5d3b-4e8a-9f61-2b8d4c6e1a90",
      "subject": "Question about my invoice",
      "folder": "inbox",
      "labels": [
        {
          "id": "c0a8012e-3b4f-4d7a-9e21-5f6a7b8c9d0e",
          "name": "Billing",
          "color": "#F76B15"
        }
      ],
      "read": false
    }
  }
}

Event triggered whenever a label is applied to or removed from a thread. Note: Moving a thread to a label can send both this event and inbox.thread.folder.updated for the same thread. Note: Deleting a label doesn’t send this event for the threads that had it.

Response Body Parameters

All webhook payloads follow a consistent top-level structure with event-specific data nested within the data object.

string

The event type that triggered the webhook (e.g., inbox.thread.labels.updated).

string

ISO 8601 timestamp when the webhook event was created.

object

Event-specific data containing detailed information about the event. The data object for the inbox.thread.labels.updated event contains the following parameters:

Hide object parameters

array

The labels applied, each with an id, name, and color. One event carries every label changed by the same request

array

The labels removed, each with an id, name, and color. One event carries every label changed by the same request

api | dashboard | agent | system

What made the change

string

The ID of the inbox

string

The ID of the thread

object

The thread, as it is when the webhook is sent. Absent when the thread no longer exists

Hide thread object

string

Always inbox_thread

string

The ID of the thread

string | null

The subject of the thread

inbox | archive | spam | sent | trash

The folder the thread lives in

array

The labels attached to the thread, each with an id, name, and color

boolean

True only when every message in the thread is read

{
  "type": "inbox.thread.labels.updated",
  "created_at": "2026-09-29T12:00:00.000Z",
  "data": {
    "added": [
      {
        "id": "c0a8012e-3b4f-4d7a-9e21-5f6a7b8c9d0e",
        "name": "Billing",
        "color": "#F76B15"
      }
    ],
    "removed": [],
    "source": "dashboard",
    "inbox_id": "b3e2b2b6-3f0e-4c8e-9ad3-2f43a1e2c7f1",
    "thread_id": "7c1f0a2e-5d3b-4e8a-9f61-2b8d4c6e1a90",
    "thread": {
      "object": "inbox_thread",
      "id": "7c1f0a2e-5d3b-4e8a-9f61-2b8d4c6e1a90",
      "subject": "Question about my invoice",
      "folder": "inbox",
      "labels": [
        {
          "id": "c0a8012e-3b4f-4d7a-9e21-5f6a7b8c9d0e",
          "name": "Billing",
          "color": "#F76B15"
        }
      ],
      "read": false
    }
  }
}

⌘I

{
  "type": "inbox.thread.labels.updated",
  "created_at": "2026-09-29T12:00:00.000Z",
  "data": {
    "added": [
      {
        "id": "c0a8012e-3b4f-4d7a-9e21-5f6a7b8c9d0e",
        "name": "Billing",
        "color": "#F76B15"
      }
    ],
    "removed": [],
    "source": "dashboard",
    "inbox_id": "b3e2b2b6-3f0e-4c8e-9ad3-2f43a1e2c7f1",
    "thread_id": "7c1f0a2e-5d3b-4e8a-9f61-2b8d4c6e1a90",
    "thread": {
      "object": "inbox_thread",
      "id": "7c1f0a2e-5d3b-4e8a-9f61-2b8d4c6e1a90",
      "subject": "Question about my invoice",
      "folder": "inbox",
      "labels": [
        {
          "id": "c0a8012e-3b4f-4d7a-9e21-5f6a7b8c9d0e",
          "name": "Billing",
          "color": "#F76B15"
        }
      ],
      "read": false
    }
  }
}

Get started

Learn

Resources

inbox.thread.labels.updated

Response Body Parameters