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

# bolt.run.started

> Payload reference for the bolt.run.started webhook event, delivered when a Paradime Bolt schedule run kicks off, with fields, trigger types, and examples.

The `bolt.run.started` event is triggered when a Bolt run starts. Use it to react to runs as they begin, for example to post a "run started" notification or to start your own timer.

The payload carries the run identifiers, the git context, and the full schedule configuration. Per-command results are not included yet (the run has only just started); those arrive with the [`bolt.run.completed`](/developers/webhooks/bolt-run-completed) event.

## Example payload

```json theme={"system"}
{
  "id": 1234,
  "api_url": "https://api.paradime.io/api/v1/abc/graphql",
  "run_url": "https://app.paradime.io/bolt/run_id/1234",
  "schedule_url": "https://app.paradime.io/bolt/4a1e7bf2-7756-3d08-aac9-a390f60d8616?workspaceUid=foo",
  "environment": {
    "actor": "Scheduler",
    "branch": "dbt-run",
    "commit_hash": "cbe09ae8b090f165e366501d0ccc164ab4019ca2",
    "email": null
  },
  "schedule": {
    "name": "Hourly Run",
    "slug": "hourly-run",
    "schedule": "@hourly",
    "environment": "production",
    "commands": ["dbt run"],
    "git_branch": "dbt-run",
    "owner_email": "fabio@paradime.io",
    "description": null,
    "notifications": null,
    "sla_minutes": null,
    "turbo_ci": null,
    "deferred_schedule": null,
    "hightouch": null,
    "env_overrides": null
  },
  "schedule_name": "Hourly Run",
  "slug": "hourly-run",
  "start_dttm": "2023-06-06 11:00:12.296501",
  "uuid": "b922fa9b-ca80-3dbd-8136-7b8be966088d",
  "workspace": {
    "name": "dbt",
    "uid": "foo"
  }
}
```

## Fields

| Field           | Type                        | Description                                   |
| --------------- | --------------------------- | --------------------------------------------- |
| `id`            | integer                     | The Bolt run ID.                              |
| `api_url`       | string                      | The GraphQL API endpoint for your workspace.  |
| `run_url`       | string                      | Link to the run in the Paradime app.          |
| `schedule_url`  | string                      | Link to the schedule in the Paradime app.     |
| `environment`   | [Environment](#environment) | The git context the run is executing against. |
| `schedule`      | [Schedule](#schedule)       | The Bolt schedule configuration.              |
| `schedule_name` | string                      | The schedule's display name.                  |
| `slug`          | string                      | The schedule's slug.                          |
| `start_dttm`    | string                      | When the run started (UTC).                   |
| `uuid`          | string                      | The run's UUID.                               |
| `workspace`     | [Workspace](#workspace)     | The workspace the run belongs to.             |

### Environment

| Field         | Type           | Description                                                             |
| ------------- | -------------- | ----------------------------------------------------------------------- |
| `actor`       | string         | Who or what triggered the run, for example `Scheduler`. Always present. |
| `branch`      | string         | The git branch.                                                         |
| `commit_hash` | string         | The git commit the run is executing against.                            |
| `email`       | string \| null | The email of the user who triggered the run, if applicable.             |

### Schedule

| Field               | Type                    | Description                                                         |
| ------------------- | ----------------------- | ------------------------------------------------------------------- |
| `name`              | string                  | The schedule display name.                                          |
| `slug`              | string                  | The schedule slug.                                                  |
| `schedule`          | string                  | The cron expression or interval, for example `@hourly`.             |
| `environment`       | string                  | The Bolt environment, for example `production`.                     |
| `commands`          | array of string         | The schedule's commands.                                            |
| `git_branch`        | string                  | The git branch the schedule runs on.                                |
| `owner_email`       | string                  | The schedule owner's email.                                         |
| `description`       | string \| null          | The schedule description.                                           |
| `notifications`     | object \| null          | Configured email, Slack, and Microsoft Teams notification channels. |
| `sla_minutes`       | integer \| null         | The schedule SLA in minutes.                                        |
| `turbo_ci`          | object \| null          | Turbo CI (deferred) configuration.                                  |
| `deferred_schedule` | object \| null          | Deferred schedule configuration.                                    |
| `hightouch`         | object \| null          | Hightouch sync configuration.                                       |
| `env_overrides`     | array of object \| null | Environment variable overrides (`key`/`value` pairs).               |

### Workspace

| Field  | Type   | Description         |
| ------ | ------ | ------------------- |
| `name` | string | The workspace name. |
| `uid`  | string | The workspace UID.  |


## Related topics

- [Getting Started](/developers/webhooks/getting-started.md)
- [Webhooks](/developers/webhooks/index.md)
- [Bolt](/developers/python-sdk/modules/bolt.md)
- [bolt.run.completed](/developers/webhooks/bolt-run-completed.md)
- [Bolt API](/developers/graphql-api/api-reference/bolt-api.md)