Event

Events are records of significant changes that occur within your Plane workspace. When a worker is created, a payment is updated, or other important actions happen, Plane generates an event that captures what changed. You can retrieve events through the API to build integrations, audit trails, or sync data with external systems. For real-time notifications, you can also receive events via webhooks.

The event object

string

Unique identifier for the event.

string

The type of event that occurred. See supported event types below.

string

The ID of the resource that the event relates to (e.g., a worker ID or payment ID).

string

The ID of the workspace where the event occurred.

object

A snapshot of the resource at the time of the event. The structure varies by event type.

string | null

The ID of the member whose action caused the event, when a member was acting. Null when Plane acted on its own or the actor is not known.

string | null

The surface the action arrived through: api, cli, mcp, or agent. Null when the action was taken in the Plane product or the surface is not known.

string

Time at which the event was created, in ISO 8601 format.

Example event

{
  "id": "evt_abc123def456",
  "type": "worker.created",
  "subject": "wr_xyz789",
  "workspace": "wsp_456def",
  "data": {
    "id": "wr_xyz789",
    "first_name": "Jane",
    "last_name": "Smith",
    "email": "jane@example.com",
    "status": "active"
  },
  "actor": null,
  "via": null,
  "created": "2024-01-15T10:30:00Z"
}

Event types

Type	Description
`worker.created`	A new worker was added to the workspace
`worker.updated`	A worker’s information was modified
`payment.created`	A new payment was created
`payment.updated`	A payment was modified
`offer.updated`	An offer changed without a lifecycle status transition
`offer.sent`	An offer was sent or returned to the sent state
`offer.expired`	An offer expired before the recipient responded
`offer.voided`	An offer was voided
`offer.accepted`	A recipient accepted an offer
`offer.declined`	A recipient declined an offer
`entity.created`	A new entity was created in the workspace
`entity.updated`	An entity was modified
`entity.verified`	An entity was verified
`changeset.applied`	A proposal was applied successfully
`changeset.failed`	A proposal finished applying with one or more failures
`changeset.cancelled`	The proposal creator withdrew a proposal
`changeset.denied`	An approver denied a proposal
`project.created`	A project was created, such as an onboarding being started
`project.completed`	Every task in a project was completed
`project.cancelled`	A project was cancelled
`task.opened`	A task became actionable: what it depended on is done
`task.completed`	A task was completed

A project event’s data is the project as the MCP projects_get tool returns it, without its tasks: subject says what the project is for, and worker names the worker it concerns. subject is a reference that holds the resource’s object type and ID, such as { "object": "worker_onboarding", "id": "won_..." } for an onboarding. A task event’s data is the task as tasks_get returns it. Its subject and assignee are references in the same shape, and its party (company, worker, or plane) says whose action the task waits on. So task.opened with a party of company means a company task has become actionable.

Changeset outcome data

All four changeset outcome events include these fields in data:

Field	Type	Description
id	string	The changeset ID
object	string	Always `changeset`
workspace	string	The workspace ID
actor	string	The member ID of the person who acted

Receiving events

There are two ways to receive events from Plane:

Poll the API

Retrieve events on your own schedule by calling the list events endpoint. Useful for batch processing or backfilling data.

Webhooks

Receive events in real-time via HTTP POST to your server. Ideal for building responsive integrations.

Working with the API

Core Resources

HR

Workforce

Benefits

Payments

Payroll

Documents

Time

Labor

Legal

The event object

Event types

Changeset outcome data

Receiving events

Poll the API

Webhooks

​The event object

​Event types

​Changeset outcome data

​Receiving events

Poll the API

Webhooks

The event object

Event types

Changeset outcome data

Receiving events