Thread locked - Plain Docs

This event is fired when a thread is locked. A locked thread cannot receive new customer messages.

Schema

View JSON Schema → Example:

{
  "timestamp": "2023-11-02T14:25:42.570Z",
  "workspaceId": "w_01GST0W989ZNAW53X6XYHAY87P",
  "payload": {
    "eventType": "thread.thread_locked",
    "previousThread": {
      "id": "th_01HD44FHMCDSSWE38N14FSYV6K",
      "customer": {
        "id": "c_01HD44FHDPG82VQ4QNHDR4N2T0",
        "email": {
          "email": "peter@example.com",
          "isVerified": false,
          "verifiedAt": null
        },
        "externalId": null,
        "fullName": "Peter Santos",
        "shortName": "Peter",
        "markedAsSpamAt": null,
        "markedAsSpamBy": null,
        "customerGroupMemberships": [],
        "createdAt": "2023-10-04T14:17:41.991Z",
        "createdBy": {
          "actorType": "system",
          "system": "email_inbound_handler"
        },
        "updatedAt": "2023-10-04T14:17:41.991Z",
        "updatedBy": {
          "actorType": "system",
          "system": "email_inbound_handler"
        }
      },
      "title": "Unable to tail logs",
      "previewText": "Hey, I am currently unable to tail the logs of the service svc-8af1e3",
      "priority": 2,
      "externalId": null,
      "status": "TODO",
      "statusChangedAt": "2023-11-02T08:57:32.943Z",
      "statusChangedBy": {
        "actorType": "user",
        "userId": "u_01H1V4NA10RMHWFBXB6A1ZBYRA"
      },
      "statusDetail": null,
      "assignee": null,
      "assignedAt": null,
      "labels": [],
      "firstInboundMessageInfo": {
        "timestamp": "2023-10-27T10:50:24.323Z",
        "messageSource": "EMAIL"
      },
      "firstOutboundMessageInfo": {
        "timestamp": "2023-10-27T10:50:52.944Z",
        "messageSource": "EMAIL"
      },
      "lastInboundMessageInfo": {
        "timestamp": "2023-10-27T15:05:30.223Z",
        "messageSource": "EMAIL"
      },
      "lastOutboundMessageInfo": {
        "timestamp": "2023-10-27T15:04:49.521Z",
        "messageSource": "EMAIL"
      },
      "supportEmailAddresses": [
        "help@example.com"
      ],
      "createdAt": "2023-10-27T10:50:24.323Z",
      "createdBy": {
        "actorType": "system",
        "system": "email_inbound_handler"
      },
      "updatedAt": "2023-11-02T08:57:32.943Z",
      "updatedBy": {
        "actorType": "user",
        "userId": "u_01H1V4NA10RMHWFBXB6A1ZBYRA"
      }
    },
    "thread": {
      "id": "th_01HD44FHMCDSSWE38N14FSYV6K",
      "customer": {
        "id": "c_01HD44FHDPG82VQ4QNHDR4N2T0",
        "email": {
          "email": "peter@example.com",
          "isVerified": false,
          "verifiedAt": null
        },
        "externalId": null,
        "fullName": "Peter Santos",
        "shortName": "Peter",
        "markedAsSpamAt": null,
        "markedAsSpamBy": null,
        "customerGroupMemberships": [],
        "createdAt": "2023-10-04T14:17:41.991Z",
        "createdBy": {
          "actorType": "system",
          "system": "email_inbound_handler"
        },
        "updatedAt": "2023-10-04T14:17:41.991Z",
        "updatedBy": {
          "actorType": "system",
          "system": "email_inbound_handler"
        }
      },
      "title": "Unable to tail logs",
      "previewText": "Hey, I am currently unable to tail the logs of the service svc-8af1e3",
      "priority": 2,
      "externalId": null,
      "status": "TODO",
      "statusChangedAt": "2023-11-02T08:57:32.943Z",
      "statusChangedBy": {
        "actorType": "user",
        "userId": "u_01H1V4NA10RMHWFBXB6A1ZBYRA"
      },
      "statusDetail": null,
      "assignee": null,
      "assignedAt": null,
      "labels": [],
      "firstInboundMessageInfo": {
        "timestamp": "2023-10-27T10:50:24.323Z",
        "messageSource": "EMAIL"
      },
      "firstOutboundMessageInfo": {
        "timestamp": "2023-10-27T10:50:52.944Z",
        "messageSource": "EMAIL"
      },
      "lastInboundMessageInfo": {
        "timestamp": "2023-10-27T15:05:30.223Z",
        "messageSource": "EMAIL"
      },
      "lastOutboundMessageInfo": {
        "timestamp": "2023-10-27T15:04:49.521Z",
        "messageSource": "EMAIL"
      },
      "supportEmailAddresses": [
        "help@example.com"
      ],
      "createdAt": "2023-10-27T10:50:24.323Z",
      "createdBy": {
        "actorType": "system",
        "system": "email_inbound_handler"
      },
      "updatedAt": "2023-11-02T08:57:32.943Z",
      "updatedBy": {
        "actorType": "user",
        "userId": "u_01H1V4NA10RMHWFBXB6A1ZBYRA"
      }
    }
  },
  "id": "pEv_01HE86SY5A9KKTACZW3FGQJ0CS",
  "webhookMetadata": {
    "webhookTargetId": "whTarget_01HD4400VTDJQ646V6RY37SR7K",
    "webhookTargetVersion": "2026-09-18",
    "webhookDeliveryAttemptId": "whAttempt_01HE86V6GP2JZCQ3D6AXK81TWD",
    "webhookDeliveryAttemptNumber": 3,
    "webhookDeliveryAttemptTimestamp": "2023-11-02T14:26:23.894Z"
  },
  "type": "thread.thread_locked"
}

Using the Webhooks SDK

You can use the @team-plain/webhooks package to parse and verify this event with full type safety:

import { verifyPlainWebhook } from "@team-plain/webhooks";

const result = verifyPlainWebhook(rawBody, signature, secret);

if (result.error) {
  console.error(result.error.message);
} else {
  // result.data is fully typed with the event payload
  const event = result.data;
  console.log(event.eventType, event.payload);
}