Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.plane.com/llms.txt

Use this file to discover all available pages before exploring further.

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

​
id
string
Unique identifier for the event.
​
type
string
The type of event that occurred. See supported event types below.
​
subject
string
The ID of the resource that the event relates to (e.g., a worker ID or payment ID).
​
workspace
string
The ID of the workspace where the event occurred.
​
data
object
A snapshot of the resource at the time of the event. The structure varies by event type.
​
created
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

TypeDescription
worker.createdA new worker was added to the workspace
worker.updatedA worker’s information was modified
payment.createdA new payment was created
payment.updatedA payment was modified

​
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.