> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cimento.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Phishing events

> Every phishing webhook event: simulation outcomes, the AutoPhish program, rounds and exclusions, with each event's fields and an example.

These events come from [AutoPhish](https://docs.cimento.ai/phishing/autophish.md). Phishing campaigns you build yourself under **Phishing campaigns** don't send webhook events.

Every event arrives in the same [envelope](https://docs.cimento.ai/webhooks/receiving-events.md#the-envelope). This page describes `data` for each `type`. The examples are spread over several lines to make them readable.

The [Cimento SDKs](https://docs.cimento.ai/webhooks/verifying-signatures.md#verify-with-a-cimento-sdk) have a type for each event's `data`: see the payload types in the [Go reference](https://pkg.go.dev/github.com/cimento-ai/cimento-sdk/go/webhooks#pkg-types), or narrow on `event.type` in [TypeScript](https://www.npmjs.com/package/@cimento/webhooks).

## Simulation outcomes

One event for each thing that happens to a simulation Cimento sent to an employee. All five share the same `data`.

| Field | Type | Description |
| - | - | - |
| `sendId` | string | The simulation that was sent to this person. The same across all the events about it. |
| `roundId` | string or `null` | The round the simulation belongs to. `null` for a simulation sent outside a round. |
| `user.id` | string | The employee's Cimento id. |
| `user.email` | string | The address the simulation was sent to. |

Activity that Cimento attributes to a mail scanner or bot, and not to the employee, doesn't send an event.

### `phishing.simulation.delivered`

The mail provider accepted a simulation for an employee's mailbox.

> [!NOTE]
>
> Delivered means the mail provider accepted the message. It does not confirm the message reached the inbox.

```json theme={null}
{
  "id": "0b6f2c1d-9e3a-4f47-8a51-6c2d3e4f5a60",
  "type": "phishing.simulation.delivered",
  "occurredAt": "2026-11-10T14:03:22.508Z",
  "data": {
    "sendId": "7c4e1a9b-2d3f-4b6a-9e8d-5f0a1b2c3d4e",
    "roundId": "d1e2f3a4-b5c6-4d7e-8f90-a1b2c3d4e5f6",
    "user": {
      "id": "0f9e8d7c-6b5a-4433-9221-100f0e0d0c0b",
      "email": "ada.lovelace@example.com"
    }
  }
}
```

### `phishing.simulation.opened`

An employee opened a simulation: their mailbox shows the message as read. Sent at most once for each simulation.

Cimento learns about an open by checking the mailbox, so this event can arrive some time after the employee read the message.

```json theme={null}
{
  "id": "1c7a3d2e-0f4b-4a58-9b62-7d3e4f5a6b71",
  "type": "phishing.simulation.opened",
  "occurredAt": "2026-11-10T14:20:05.112Z",
  "data": {
    "sendId": "7c4e1a9b-2d3f-4b6a-9e8d-5f0a1b2c3d4e",
    "roundId": "d1e2f3a4-b5c6-4d7e-8f90-a1b2c3d4e5f6",
    "user": {
      "id": "0f9e8d7c-6b5a-4433-9221-100f0e0d0c0b",
      "email": "ada.lovelace@example.com"
    }
  }
}
```

### `phishing.simulation.clicked`

An employee clicked the link in a simulation. You can receive more than one of these for the same `sendId`, so count simulations or people, not events.

```json theme={null}
{
  "id": "2d8b4e3f-1a5c-4b69-8c73-8e4f5a6b7c82",
  "type": "phishing.simulation.clicked",
  "occurredAt": "2026-11-10T14:21:48.930Z",
  "data": {
    "sendId": "7c4e1a9b-2d3f-4b6a-9e8d-5f0a1b2c3d4e",
    "roundId": "d1e2f3a4-b5c6-4d7e-8f90-a1b2c3d4e5f6",
    "user": {
      "id": "0f9e8d7c-6b5a-4433-9221-100f0e0d0c0b",
      "email": "ada.lovelace@example.com"
    }
  }
}
```

### `phishing.simulation.reported`

An employee reported a simulation as phishing.

```json theme={null}
{
  "id": "3e9c5f4a-2b6d-4c7a-9d84-9f5a6b7c8d93",
  "type": "phishing.simulation.reported",
  "occurredAt": "2026-11-10T15:02:11.047Z",
  "data": {
    "sendId": "8d5f2b0c-3e4a-4c7b-8f9e-6a1b2c3d4e5f",
    "roundId": "d1e2f3a4-b5c6-4d7e-8f90-a1b2c3d4e5f6",
    "user": {
      "id": "1a0f9e8d-7c6b-4544-8332-211a0f0e0d0c",
      "email": "grace.hopper@example.com"
    }
  }
}
```

### `phishing.simulation.no_action`

Seven days passed after a simulation was delivered with no click and no report.

> [!NOTE]
>
> This event arrives seven days after the simulation, not when it is sent. An employee who only opened the message still gets it. If they click after the seven days, you receive a `clicked` event as well.

```json theme={null}
{
  "id": "4fad6a5b-3c7e-4d8b-8e95-a06b7c8d9ea4",
  "type": "phishing.simulation.no_action",
  "occurredAt": "2026-11-17T14:03:22.508Z",
  "data": {
    "sendId": "9e6a3c1d-4f5b-4d8c-9a0f-7b2c3d4e5f6a",
    "roundId": "d1e2f3a4-b5c6-4d7e-8f90-a1b2c3d4e5f6",
    "user": {
      "id": "2b1a0f9e-8d7c-4655-9443-322b1a0f0e0d",
      "email": "alan.turing@example.com"
    }
  }
}
```

## Training after a click

### `phishing.remediation.completed`

An employee finished the training they were given after a simulation.

| Field | Type | Description |
| - | - | - |
| `sendId` | string | The simulation the training followed. |
| `user.id` | string | The employee's Cimento id. |
| `user.email` | string | The address the simulation was sent to. |

```json theme={null}
{
  "id": "5a0b7b6c-4d8f-4e9c-9fa6-b17c8d9eafb5",
  "type": "phishing.remediation.completed",
  "occurredAt": "2026-11-10T14:27:39.276Z",
  "data": {
    "sendId": "7c4e1a9b-2d3f-4b6a-9e8d-5f0a1b2c3d4e",
    "user": {
      "id": "0f9e8d7c-6b5a-4433-9221-100f0e0d0c0b",
      "email": "ada.lovelace@example.com"
    }
  }
}
```

## The program

### `phishing.program.enabled`

An admin turned phishing simulations on.

| Field | Type | Description |
| - | - | - |
| `actorId` | string or `null` | The admin who turned it on. |

```json theme={null}
{
  "id": "6b1c8c7d-5e9a-4fad-8ab7-c28d9eafb0c6",
  "type": "phishing.program.enabled",
  "occurredAt": "2026-11-03T09:15:00.402Z",
  "data": {
    "actorId": "3c2b1a0f-9e8d-4766-8554-433c2b1a0f0e"
  }
}
```

### `phishing.program.disabled`

An admin turned phishing simulations off.

| Field | Type | Description |
| - | - | - |
| `actorId` | string or `null` | The admin who turned it off. |
| `cancelledSends` | number | How many simulations that were scheduled and not yet sent were cancelled. |

```json theme={null}
{
  "id": "7c2d9d8e-6fab-4abe-9bc8-d39eafb0c1d7",
  "type": "phishing.program.disabled",
  "occurredAt": "2026-11-12T17:30:44.019Z",
  "data": {
    "actorId": "3c2b1a0f-9e8d-4766-8554-433c2b1a0f0e",
    "cancelledSends": 42
  }
}
```

### `phishing.program.reset`

An admin reset the phishing program to its setup state. `data` has the same fields as `phishing.program.disabled`.

```json theme={null}
{
  "id": "8d3eae9f-7abc-4bcf-8cd9-e4afb0c1d2e8",
  "type": "phishing.program.reset",
  "occurredAt": "2026-11-12T17:45:10.655Z",
  "data": {
    "actorId": "3c2b1a0f-9e8d-4766-8554-433c2b1a0f0e",
    "cancelledSends": 0
  }
}
```

## Rounds

A round is one batch of simulations. `period` names the week or month it covers: `2026-W46` for a weekly round, `2026-11` for a monthly one. A round for new joiners has a `period` such as `joiners-2026-11-12`.

### `phishing.round.started`

A round of simulations was planned and began sending.

| Field | Type | Description |
| - | - | - |
| `roundId` | string | The round. Matches `roundId` on its simulations' events. |
| `period` | string | The week or month the round covers. |
| `plannedSends` | number | How many simulations the round plans to send. |

```json theme={null}
{
  "id": "9e4fbfa0-8bcd-4cd0-9dea-f5b0c1d2e3f9",
  "type": "phishing.round.started",
  "occurredAt": "2026-11-09T08:00:03.771Z",
  "data": {
    "roundId": "d1e2f3a4-b5c6-4d7e-8f90-a1b2c3d4e5f6",
    "period": "2026-W46",
    "plannedSends": 318
  }
}
```

### `phishing.round.skipped`

An admin skipped a round of simulations.

| Field | Type | Description |
| - | - | - |
| `roundId` | string | The round. |
| `period` | string | The week or month the round covers. |
| `cancelledSends` | number | How many of the round's scheduled simulations were cancelled. |
| `actorId` | string or `null` | The admin who skipped it. |

```json theme={null}
{
  "id": "af50c0b1-9cde-4de1-8efb-06c1d2e3f40a",
  "type": "phishing.round.skipped",
  "occurredAt": "2026-11-09T11:12:57.203Z",
  "data": {
    "roundId": "e2f3a4b5-c6d7-4e8f-9a01-b2c3d4e5f6a7",
    "period": "2026-11",
    "cancelledSends": 318,
    "actorId": "3c2b1a0f-9e8d-4766-8554-433c2b1a0f0e"
  }
}
```

A round that simply reaches the end of its period sends no event.

## Exclusions

An excluded employee gets no simulations.

> [!NOTE]
>
> An exclusion with an end date that simply runs out sends no event. `phishing.exclusion.removed` is sent only when an admin removes an exclusion.

### `phishing.exclusion.added`

An employee was excluded from phishing simulations, by an admin or by Cimento.

| Field | Type | Description |
| - | - | - |
| `user.id` | string | The employee's Cimento id. |
| `user.email` | string or `null` | Their email address. |
| `actorId` | string or `null` | The admin who excluded them. `null` when Cimento did. |
| `reason` | string or `null` | Why Cimento excluded them. `null` when an admin did. Today the one reason is that the mail provider did not find the mailbox in two rounds running. Treat it as text to show, not a value to match. |

```json theme={null}
{
  "id": "b061d1c2-adef-4ef2-9f0c-17d2e3f4a51b",
  "type": "phishing.exclusion.added",
  "occurredAt": "2026-11-11T10:05:31.884Z",
  "data": {
    "user": {
      "id": "4d3c2b1a-0f9e-4877-9665-544d3c2b1a0f",
      "email": "katherine.johnson@example.com"
    },
    "actorId": "3c2b1a0f-9e8d-4766-8554-433c2b1a0f0e",
    "reason": null
  }
}
```

Excluding someone who is already excluded, or changing how long their exclusion lasts, sends no event.

### `phishing.exclusion.removed`

An admin removed an employee's exclusion from phishing simulations.

| Field | Type | Description |
| - | - | - |
| `user.id` | string | The employee's Cimento id. |
| `user.email` | string or `null` | Their email address. |
| `actorId` | string or `null` | The admin who removed it. |

```json theme={null}
{
  "id": "c172e2d3-bef0-4f03-8a1d-28e3f4a5b62c",
  "type": "phishing.exclusion.removed",
  "occurredAt": "2026-11-12T13:40:18.560Z",
  "data": {
    "user": {
      "id": "4d3c2b1a-0f9e-4877-9665-544d3c2b1a0f",
      "email": "katherine.johnson@example.com"
    },
    "actorId": "3c2b1a0f-9e8d-4766-8554-433c2b1a0f0e"
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.