Events

An event records one change in a workspace, such as a role change, a new invite or a ticket update, and who made it: a person, a clanker acting for a person, or an account API key.

The Event object

One change in the workspace and who made it.

Attributes

idstringRequired

Unique ID of the event.

typestringRequired

What happened, as subject.action, such as ticket.created.

One ofworkspace.createdworkspace.updatedworkspace.icon_updatedmember.role_changedmember.removedmember.auto_joinedinvite.createdinvite.role_changedinvite.resentinvite.revokedinvite.acceptedteam.createdteam.updatedteam.member_addedteam.member_removedteam.archivedteam.restoredteam.deletedproject.createdproject.updatedproject.archivedproject.restoredproject.reorderedmilestone.createdmilestone.updatedmilestone.deletedticket.createdticket.updatedticket.movedticket.reorderedticket.checklist_changedticket.checklist_item_checkedticket.checklist_item_uncheckedticket.checklist_item_startedticket.checklist_item_stoppedticket.document_writtenticket.question_askedticket.question_answeredticket.branch_linkedticket.branch_unlinkedticket.pull_request_linkedticket.pull_request_unlinkedtag.createdtag.updatedtag.deletedticket_status.createdticket_status.updatedticket_status.deletedticket_status.reorderedticket_status.checklist_changedticket_status.instructions_changedview.createdview.updatedview.deletedview.reorderedclanker_instructions.updatedclanker_instructions.resetclanker.registeredclanker.revokedclanker_message.sentclanker_message.deliveredclanker_message.completedticket.commentedproduct.createdproduct.updatedproduct.archivedproduct.restoredenvironment.createdenvironment.updatedenvironment.archivedenvironment.restoreddeployment.createddeployment.updateddeployment.removedprofile.updated

subjectTypenullable stringRequired

What the event is about, such as user, invite, workspace or ticket, or null.

subjectIdnullable stringRequired

The ID of what the event is about, or null.

metadataobjectRequired

Details recorded with the event, such as the ticket's identifier and title. The fields depend on the type.

createdAtstringRequired

When it happened, as an ISO 8601 timestamp.

actorUserIdnullable stringRequired

The user ID of the person who made the change, or the person a clanker acted for. Null when an account API key made it.

actorAccountKeyIdnullable stringRequired

The ID of the account API key that made the change, or null.

actorClankerAuthorizationIdnullable stringRequired

The ID of the clanker that made the change for the person, or null.

actorNamenullable stringRequired

The name of the person who made the change, or the person a clanker acted for. Null when an account API key made it.

actorEmailnullable stringRequired

That person's email address, or null.

clankerNamenullable stringRequired

The clanker that made the change for the person, such as Codex, or null.

The Event object

{  "id": "Ev4NpL7wQs2X",  "type": "ticket.created",  "subjectType": "ticket",  "subjectId": "Tk7BnC5xLp9M",  "metadata": {    "identifier": "WEB-31",    "title": "Add docs search"  },  "createdAt": "2026-10-14T09:05:12.000Z",  "actorUserId": "Us3NfP8kLq2V",  "actorAccountKeyId": null,  "actorClankerAuthorizationId": "Ag5HvB1mZr8K",  "actorName": "Maya Patel",  "actorEmail": "maya@acme.dev",  "clankerName": "Codex"}

List events

GET/v1/workspaces/{slug}/events

Returns the 50 most recent events the caller can read, newest first, or one ticket's activity with ticket. Members and viewers get the workspace's own events and those about the teams, projects and tickets they can open; a personal view's events go only to its person. Owners, admins and account API keys get every event. A ticket the caller cannot read fails with NotFound.

Path parameters

slugstringRequired

The workspace's slug or ID, such as acme.

Query parameters

ticketstring

Only this ticket's activity, by its ID, such as WEB-31.

Returns

Returns an array of Event objects. Status 200.

Errors

400: InvalidInputThe request is malformed, or a value is not allowed.
401: UnauthorizedThe request has no valid API key.
403: ForbiddenThe key's user or role may not do this.
404: NotFoundThe workspace or object does not exist, or the caller cannot see it.
409: ConflictThe change conflicts with current data, such as a slug that is already in use.
500: InternalClanker Ship failed to handle the request. Retry, or report the response's x-request-id.

GET/v1/workspaces/{slug}/events

1curl https://api.clankership.com/v1/workspaces/acme/events \2  -H "Authorization: Bearer $CLANKER_API_KEY"

Response200

[  {    "id": "Ev4NpL7wQs2X",    "type": "ticket.created",    "subjectType": "ticket",    "subjectId": "Tk7BnC5xLp9M",    "metadata": {      "identifier": "WEB-31",      "title": "Add docs search"    },    "createdAt": "2026-10-14T09:05:12.000Z",    "actorUserId": "Us3NfP8kLq2V",    "actorAccountKeyId": null,    "actorClankerAuthorizationId": "Ag5HvB1mZr8K",    "actorName": "Maya Patel",    "actorEmail": "maya@acme.dev",    "clankerName": "Codex"  }]

NextAccount API keys