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

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

Example event

{
  "id": "evt_abc123def456",
  "type": "worker.created",
  "subject": "wr_xyz789",
  "workspace": "ws_456def",
  "data": {
    "id": "wr_xyz789",
    "first_name": "Jane",
    "last_name": "Smith",
    "email": "jane@example.com",
    "status": "active"
  },
  "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

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

Receiving events

Poll the API

Webhooks

​The event object

​Event types

​Receiving events

Poll the API

Webhooks

The event object

Event types

Receiving events