Skip to main content
Project events track actions related to project creation, configuration, and access views. These events record when users create projects, modify project settings, and view project information.
All project events include the standard actor, targets, context, and metadata fields. The schemas below show event-specific fields.

project.create

Records when a new project is created within an organization.

Triggered When

User creates a new project through the project creation form.

Event Schema

action
string
required
project.create
targets
array
required
metadata.source
string
required
Page route where project was created (e.g., /organizations/[orgId]/projects/new)

Example Event

{
  "action": "project.create",
  "occurredAt": "2025-01-15T10:30:00.000Z",
  "version": 1,
  "actor": {
    "type": "user",
    "id": "user_01JGXYZ123",
    "name": "Alice Johnson",
    "metadata": {
      "first_name": "Alice",
      "last_name": "Johnson",
      "email": "alice@example.com",
      "impersonator_email": "",
      "impersonator_reason": ""
    }
  },
  "targets": [
    {
      "type": "project",
      "id": "proj_01JGXYZ789",
      "name": "Production Environment",
      "metadata": {
        "organization_id": "org_01JGXYZ456"
      }
    }
  ],
  "context": {
    "location": "192.0.2.1",
    "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)..."
  },
  "metadata": {
    "source": "/organizations/org_01JGXYZ456/projects/new"
  }
}

project.update_name

Records when a project’s name is changed.

Triggered When

User with owner or editor permissions updates the project name in project settings.

Event Schema

action
string
required
project.update_name
targets
array
required
metadata.source
string
required
Always project_settings

Example Event

{
  "action": "project.update_name",
  "occurredAt": "2025-01-15T14:20:00.000Z",
  "version": 1,
  "actor": {
    "type": "user",
    "id": "user_01JGXYZ123",
    "name": "Alice Johnson",
    "metadata": {
      "first_name": "Alice",
      "last_name": "Johnson",
      "email": "alice@example.com",
      "impersonator_email": "",
      "impersonator_reason": ""
    }
  },
  "targets": [
    {
      "type": "project",
      "id": "proj_01JGXYZ789",
      "name": "Production API",
      "metadata": {
        "old_name": "Production Environment",
        "new_name": "Production API",
        "organization_id": "org_01JGXYZ456"
      }
    }
  ],
  "context": {
    "location": "192.0.2.1",
    "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)..."
  },
  "metadata": {
    "source": "project_settings"
  }
}

project.delete

Records when a project is permanently deleted from an organization.

Triggered When

User with owner permissions deletes a project via the delete action in project settings.

Event Schema

action
string
required
project.delete
targets
array
required
metadata.source
string
required
Page route where project was deleted: /projects/[projectId]/settings

Example Event

{
  "action": "project.delete",
  "occurredAt": "2025-01-16T11:00:00.000Z",
  "version": 1,
  "actor": {
    "type": "user",
    "id": "user_01JGXYZ123",
    "name": "Alice Johnson",
    "metadata": {
      "first_name": "Alice",
      "last_name": "Johnson",
      "email": "alice@example.com",
      "impersonator_email": "",
      "impersonator_reason": ""
    }
  },
  "targets": [
    {
      "type": "project",
      "id": "proj_01JGXYZ789",
      "name": "Production Environment",
      "metadata": {
        "name": "Production Environment",
        "organization_id": "org_01JGXYZ456"
      }
    }
  ],
  "context": {
    "location": "192.0.2.1",
    "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)..."
  },
  "metadata": {
    "source": "/projects/proj_01JGXYZ789/settings"
  }
}

project.view_settings

Records when a user views the project settings page.

Triggered When

User navigates to the project settings page.

Event Schema

action
string
required
project.view_settings
targets
array
required
metadata.source
string
required
Page route (e.g., /projects/[projectId]/settings)

Example Event

{
  "action": "project.view_settings",
  "occurredAt": "2025-01-15T09:15:00.000Z",
  "version": 1,
  "actor": {
    "type": "user",
    "id": "user_01JGXYZ123",
    "name": "Alice Johnson",
    "metadata": {
      "first_name": "Alice",
      "last_name": "Johnson",
      "email": "alice@example.com",
      "impersonator_email": "",
      "impersonator_reason": ""
    }
  },
  "targets": [
    {
      "type": "project",
      "id": "proj_01JGXYZ789",
      "name": "Production Environment",
      "metadata": {
        "name": "Production Environment",
        "organization_id": "org_01JGXYZ456"
      }
    }
  ],
  "context": {
    "location": "192.0.2.1",
    "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)..."
  },
  "metadata": {
    "source": "/projects/proj_01JGXYZ789/settings"
  }
}

project.list

Records when a user views the list of projects in an organization.

Triggered When

User navigates to the organization’s projects page.

Event Schema

action
string
required
project.list
targets
array
required
metadata.source
string
required
Page route (e.g., /organizations/[orgId]/projects)
metadata.total_projects
string
required
Total number of projects accessible to the user (as string)

Example Event

{
  "action": "project.list",
  "occurredAt": "2025-01-15T11:45:00.000Z",
  "version": 1,
  "actor": {
    "type": "user",
    "id": "user_01JGXYZ123",
    "name": "Alice Johnson",
    "metadata": {
      "first_name": "Alice",
      "last_name": "Johnson",
      "email": "alice@example.com",
      "impersonator_email": "",
      "impersonator_reason": ""
    }
  },
  "targets": [
    {
      "type": "organization",
      "id": "org_01JGXYZ456",
      "name": "Acme Corp",
      "metadata": {
        "name": "Acme Corp"
      }
    }
  ],
  "context": {
    "location": "192.0.2.1",
    "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)..."
  },
  "metadata": {
    "source": "/organizations/org_01JGXYZ456/projects",
    "total_projects": "5"
  }
}

project.list_memberships

Records when a user views the list of members in a project.

Triggered When

User queries the project members list via the members API endpoint.

Event Schema

action
string
required
project.list_memberships
targets
array
required
metadata.source
string
required
Page route where members were listed (e.g., /projects/[projectId]/members)
metadata.page
string
required
Page number in pagination (as string)
metadata.limit
string
required
Number of results per page (as string)
metadata.total_results
string
required
Total number of members returned (as string)
metadata.query
string
Search query used to filter members (empty string if no filter)

Example Event

{
  "action": "project.list_memberships",
  "occurredAt": "2025-01-15T13:30:00.000Z",
  "version": 1,
  "actor": {
    "type": "user",
    "id": "user_01JGXYZ123",
    "name": "Alice Johnson",
    "metadata": {
      "first_name": "Alice",
      "last_name": "Johnson",
      "email": "alice@example.com",
      "impersonator_email": "",
      "impersonator_reason": ""
    }
  },
  "targets": [
    {
      "type": "project",
      "id": "proj_01JGXYZ789",
      "name": "Production Environment",
      "metadata": {
        "name": "Production Environment",
        "organization_id": "org_01JGXYZ456"
      }
    }
  ],
  "context": {
    "location": "192.0.2.1",
    "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)..."
  },
  "metadata": {
    "source": "/projects/proj_01JGXYZ789/members",
    "page": "1",
    "limit": "50",
    "total_results": "8",
    "query": ""
  }
}

project.list_available_invitees

Records when a user views the list of organization members who can be invited to a project.

Triggered When

User queries the available invitees list via the available invitees API endpoint (typically when adding new project members).

Event Schema

action
string
required
project.list_available_invitees
targets
array
required
metadata.source
string
required
Page route where available invitees were listed (e.g., /projects/[projectId]/available-invitees)
metadata.page
string
required
Page number in pagination (as string)
metadata.limit
string
required
Number of results per page (as string)
metadata.total_results
string
required
Total number of available invitees returned (as string)
metadata.query
string
Search query used to filter available invitees (empty string if no filter)

Example Event

{
  "action": "project.list_available_invitees",
  "occurredAt": "2025-01-15T15:00:00.000Z",
  "version": 1,
  "actor": {
    "type": "user",
    "id": "user_01JGXYZ123",
    "name": "Alice Johnson",
    "metadata": {
      "first_name": "Alice",
      "last_name": "Johnson",
      "email": "alice@example.com",
      "impersonator_email": "",
      "impersonator_reason": ""
    }
  },
  "targets": [
    {
      "type": "project",
      "id": "proj_01JGXYZ789",
      "name": "Production Environment",
      "metadata": {
        "name": "Production Environment",
        "organization_id": "org_01JGXYZ456"
      }
    }
  ],
  "context": {
    "location": "192.0.2.1",
    "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)..."
  },
  "metadata": {
    "source": "/projects/proj_01JGXYZ789/available-invitees",
    "page": "1",
    "limit": "50",
    "total_results": "15",
    "query": ""
  }
}
This event shows organization members who are not yet project members. The list excludes users who already have access to the project.