# Event catalog

These are the events Volobox can deliver to a webhook. Events that never leave the workspace, such as chat messages and meetings, are not listed and are never sent. How to add a webhook and choose its events is in [Webhooks](/docs/webhooks); how to verify and process a delivery is in [Receive and verify webhooks](/docs/receive-webhooks).

The **Event** column is the key a delivery names in its body and in the `X-Volobox-Event` header, except app events (see `app.event.published`). **Scope** is the kind of place the event happens in.

> **Note:** Events about coding assignments, coding sessions, Docs pages, Docs spaces, files and folders, members, shared drives and workflow runs are recorded only while something listens for them, such as a webhook. Events from before that are not sent.

## Alerts

| Event | Scope | Description |
| --- | --- | --- |
| `alert.acknowledged` | Alert | A person acknowledged an alert for everybody it is addressed to. |
| `alert.escalated` | Alert | An active alert's source raised its severity. |
| `alert.raised` | Alert | A condition started to hold: a new alert, or one raised again after it resolved. Not raised again while it stays active. Carries ids, severity and a label, never the alert's summary; a personal alert never leaves the workspace. |
| `alert.resolved` | Alert | An alert's source reported that the condition no longer holds. |

## Coding assignments

| Event | Scope | Description |
| --- | --- | --- |
| `coding_assignment.completed` | Project | An agent finished a coding assignment. |
| `coding_assignment.failed` | Project | An agent's coding assignment failed. |
| `coding_assignment.started` | Project | An agent started working on a task assigned to it for coding. |

## Coding sessions

| Event | Scope | Description |
| --- | --- | --- |
| `coding_session.archived` | Repository | A coding session on a repository was archived. |
| `coding_session.created` | Repository | A coding session was started on a repository. Carries no title: a session's title can quote a task the reader may not see. |

## Custom apps

> **Note:** Available where the workspace uses custom apps.

| Event | Scope | Description |
| --- | --- | --- |
| `app.event.published` | App | A rule of a published custom app published an event its app.json declares. Delivered as `app.{appKey}.{event}`, such as `app.orders.order.placed`. |

## Docs pages

| Event | Scope | Description |
| --- | --- | --- |
| `page.created` | Docs space | A page was created in a shared Docs space, by hand, as a copy or as a duplicate. |
| `page.deleted` | Docs space | A page was moved to the trash. |
| `page.moved` | Docs space | A page moved in its space or to another one. Scoped to the destination space. |
| `page.revision.restored` | Docs space | An earlier revision of a page was restored. |
| `page.sharing.changed` | Docs space | Who may open a page changed: a member added or removed, or its visibility reset. |

## Docs spaces

| Event | Scope | Description |
| --- | --- | --- |
| `space.created` | Docs space | A shared Docs space was created. |
| `space.deleted` | Docs space | A shared Docs space was deleted. |
| `space.member.added` | Docs space | A person, group or agent was added to a shared Docs space. |
| `space.member.removed` | Docs space | A person, group or agent was removed from a shared Docs space. |
| `space.member.role.changed` | Docs space | A Docs space member's role changed. |
| `space.updated` | Docs space | A shared Docs space's settings changed. Names the fields. |

## Files and folders

| Event | Scope | Description |
| --- | --- | --- |
| `file.deleted` | Shared drive | A file or folder in a shared drive was deleted for good. |
| `file.link.changed` | Shared drive | A share link of a file or folder in a shared drive was turned on, changed or turned off. |
| `file.moved` | Shared drive | A file or folder moved within, into or out of a shared drive. Scoped to the destination drive, or to the drive it left for a personal one. |
| `file.renamed` | Shared drive | A file or folder in a shared drive was renamed. |
| `file.restored` | Shared drive | A file or folder in a shared drive was restored from the trash. |
| `file.sharing.changed` | Shared drive | Who may open a file or folder in a shared drive changed. |
| `file.trashed` | Shared drive | A file or folder in a shared drive was moved to the trash. |
| `file.uploaded` | Shared drive | A file was added to a shared drive: uploaded, created as text or copied. |
| `file.version.added` | Shared drive | A new version of a file in a shared drive was uploaded. |
| `file.version.restored` | Shared drive | An earlier version of a file in a shared drive was restored. |
| `folder.created` | Shared drive | A folder was created in a shared drive. |

## Members

| Event | Scope | Description |
| --- | --- | --- |
| `member.deactivated` | Workspace | A member was deactivated. |
| `member.joined` | Workspace | A person became a member of the workspace. Names the person's id only. |
| `member.reactivated` | Workspace | A deactivated member was activated again. |

## Milestones

| Event | Scope | Description |
| --- | --- | --- |
| `milestone.closed` | Project | A milestone was closed. |
| `milestone.created` | Project | A milestone was created in a project. |
| `milestone.deleted` | Project | A milestone was deleted. |
| `milestone.reopened` | Project | A closed milestone was reopened. |
| `milestone.updated` | Project | A milestone's name, description or dates changed. |

## Pipeline runs

| Event | Scope | Description |
| --- | --- | --- |
| `pipeline.run.failed` | Project | A run of an Azure DevOps pipeline linked to a project failed, whoever started it and from where. Carries the linked pipeline, the run's id, branch and commit, never its log. |
| `pipeline.run.succeeded` | Project | A run of an Azure DevOps pipeline linked to a project succeeded, fully or partially; the result says which. A canceled run raises nothing. |

## Projects

| Event | Scope | Description |
| --- | --- | --- |
| `project.archived` | Project | A project was archived. |
| `project.created` | Project | A project was created. |
| `project.deleted` | Project | A project was deleted. |
| `project.member.added` | Project | A person, group or agent was added to a project. |
| `project.member.removed` | Project | A person, group or agent was removed from a project. |
| `project.member.role.changed` | Project | A project member's role changed. |
| `project.unarchived` | Project | An archived project was restored. |
| `project.updated` | Project | A project's settings, slug or agent guidance changed. |

## Pull requests

| Event | Scope | Description |
| --- | --- | --- |
| `pull_request.ai_review.completed` | Repository | An AI review of a pull request finished with a verdict. |
| `pull_request.ai_review.failed` | Repository | An organization AI review of a pull request failed before it reached a verdict. Carries the head it was of and the failure's code as its outcome when the failure was a known one. |
| `pull_request.checks.completed` | Repository | The CI of an open pull request settled at its head: every deciding check finished. Once per head and outcome; names the checks that failed. |
| `pull_request.ci_fix.completed` | Repository | A CI repair round on a pull request ended: green, gave up, or could not start. |
| `pull_request.closed` | Repository | A pull request was closed without merging. |
| `pull_request.merged` | Repository | A pull request was merged. |
| `pull_request.opened` | Repository | A pull request was opened. |
| `pull_request.ready_for_review` | Repository | A draft pull request was marked ready for review. |
| `pull_request.reopened` | Repository | A closed pull request was reopened. |
| `pull_request.review.submitted` | Repository | A reviewer submitted a review on the code host (approved, changes requested or commented). |

## Requests

| Event | Scope | Description |
| --- | --- | --- |
| `request.assigned` | Project | A person or an agent was added to a request's assignees; one event per assignee. |
| `request.closed` | Project | A request was closed: by a person, or by the last open task made from it or given it. |
| `request.converted` | Project | A request was linked to a task: a task was made from it, alone or with other requests, or it was added to an existing task. |
| `request.created` | Project | A request was created. |
| `request.deleted` | Project | A request was deleted. |
| `request.reopened` | Project | A closed request was reopened: by a person, or because a task made from it or given it was reopened. |
| `request.status.changed` | Project | A request was closed, reopened or converted into a task. |
| `request.updated` | Project | A request's fields changed. One event per save, naming the fields. |

## Shared drives

| Event | Scope | Description |
| --- | --- | --- |
| `drive.created` | Shared drive | A shared drive was created. |
| `drive.deleted` | Shared drive | A shared drive was deleted. |
| `drive.member.added` | Shared drive | A person, group or agent was added to a shared drive. |
| `drive.member.removed` | Shared drive | A person, group or agent was removed from a shared drive. |
| `drive.member.role.changed` | Shared drive | A shared drive member's role changed. |
| `drive.updated` | Shared drive | A shared drive's settings changed. Names the fields. |

## Support tickets

> **Note:** Available where the workspace uses Support.

| Event | Scope | Description |
| --- | --- | --- |
| `ticket.assigned` | Support desk | A support ticket was assigned, reassigned or unassigned. |
| `ticket.customer.replied` | Support desk | A customer replied on a support ticket. |
| `ticket.merged` | Support desk | A support ticket was merged into another; the event names the ticket that was merged away. |
| `ticket.opened` | Support desk | A customer opened a support ticket. |
| `ticket.reopened` | Support desk | A resolved or closed support ticket was opened again. |
| `ticket.status.changed` | Support desk | A support ticket's status changed. A reopen raises `ticket.reopened` instead. |

## Tasks

| Event | Scope | Description |
| --- | --- | --- |
| `task.assigned` | Project | A person or an agent was added to a task's assignees; one event per assignee. |
| `task.closed` | Project | A task was closed, by a person, an agent, a merged pull request or a synced tracker. |
| `task.column.pinned` | Project | A task was pinned to a board column. |
| `task.comment.added` | Project | A person posted in a task's discussion. |
| `task.created` | Project | A task was created. |
| `task.deleted` | Project | A task was deleted. |
| `task.moved` | Project | A task was moved to another project. Scoped to the destination project. |
| `task.reopened` | Project | A closed task was reopened. |
| `task.status.changed` | Project | A task's status or work state changed. A close also raises `task.closed` after it. |
| `task.updated` | Project | A task's fields changed (title, description, priority, dates, labels, milestone, area, type, effort, parent or assignees). One event per save, naming the fields. |

## Workflow runs

| Event | Scope | Description |
| --- | --- | --- |
| `workflow.run.completed` | Workflow | A run of a shared workflow completed. |
| `workflow.run.failed` | Workflow | A run of a shared workflow failed. |
| `workflow.run.waiting` | Workflow | A run of a shared workflow stopped to wait for an answer or an approval. |
