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
Unique identifier for the event.
The ID of the resource that the event relates to (e.g., a worker ID or payment ID).
The ID of the workspace where the event occurred.
A snapshot of the resource at the time of the event. The structure varies by event type.
Time at which the event was created, in ISO 8601 format.
{
"id": "evt_abc123def456",
"type": "worker.created",
"subject": "wr_xyz789",
"workspace": "ws_456def",
"data": {
"id": "wr_xyz789",
"first_name": "Jane",
"last_name": "Smith",
"email": "[email protected]",
"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 |
Receiving events
There are two ways to receive events from Plane:
