Home/Other/Events

Events Data Structures

Events represent actions that occurred within the system (e.g., resource creation, updates, deletions). Use the Events API to list and retrieve events in your organization.

Event object

Events represent actions that occurred within the system (e.g., resource creation, updates, deletions). Use the Events API to list and retrieve events in your organization.

Fields

Name	Type	Required	Description
id	string	Required	Unique identifier for the event (evt_ prefix)
object	string	Required	Object type (always "event")
type	string	Required	Event type (e.g. invoice.created, crm.deal.updated)
organization_id	string	Required	ID of the organization where the event occurred
data	object	Required	Resource data at the time of the event
previous_attributes	object \| null	Optional	For update events, the previous attribute values
request_id	string \| null	Optional	ID of the API request that triggered the event
created_at	string (ISO 8601)	Required	Timestamp when the event occurred

{
  "id": "evt_a1b2c3d4-5678-90ab-cdef-1234567890ab",
  "object": "event",
  "type": "invoice.created",
  "organization_id": "org_abc123",
  "data": {
    "id": "inv_def456",
    "object": "invoice",
    "status": "draft",
    "total_amount": 110000
  },
  "previous_attributes": null,
  "request_id": "req_xyz789",
  "created_at": "2026-01-15T10:30:00Z"
}

Event Types

Below is a list of currently supported event types. These values are set in the type field of an event.

Type	Description
invoice.created	An invoice was created
invoice.updated	An invoice was updated
invoice.deleted	An invoice was deleted
invoice.approved	An invoice was approved
invoice.sent	An invoice was sent to the customer
invoice.paid	An invoice was marked as paid
invoice.cancelled	An invoice was cancelled
crm.deal.created	A CRM deal was created
crm.deal.updated	A CRM deal was updated
crm.deal.deleted	A CRM deal was deleted
crm.deal.stage_updated	A CRM deal stage was updated
crm.company.created	A CRM company was created
crm.company.updated	A CRM company was updated
crm.company.deleted	A CRM company was deleted
crm.contact.created	A CRM contact was created
crm.contact.updated	A CRM contact was updated
crm.contact.deleted	A CRM contact was deleted
crm.activity.created	A CRM activity was created
crm.activity.deleted	A CRM activity was deleted
attendance.record.clocked_in	A clock-in was recorded
attendance.record.clocked_out	A clock-out was recorded
mail.campaign.sent	A mail campaign was sent
forms.response.submitted	A form response was submitted
customer.created	A customer was created
customer.updated	A customer was updated
customer.deleted	A customer was deleted
conversion.completed	A document conversion was completed

Endpoints

GET/api/v1/events

List events in your organization. Results are returned in reverse chronological order.

Query Parameters

type	string	Filter by event type (e.g. invoice.created)
limit	integer	Number of results (default: 20, max: 100)
starting_after	string	Event ID for cursor-based pagination

GET/api/v1/events/{id}

Retrieve a specific event by ID.

Path Parameters

string

ID of the event to retrieve (evt_ prefix)