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

# Automation Tools

> Create, manage, and inspect organization automations and their executions

The Bizzy MCP server provides 7 tools for managing automations and inspecting
their execution history. These tools are organized into two categories:
automations and executions.

## Automations

Core tools for creating, reading, updating, and deleting automations.

### createAutomation

Create a new automation with trigger event, conditions, and instructions.

**Permission:** `automations:write`

**Parameters:**

| Name           | Type                                | Required | Description                                                                                                                   |
| -------------- | ----------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `name`         | string                              | Yes      | The name of the automation                                                                                                    |
| `description`  | string                              | No       | A description of what the automation does                                                                                     |
| `triggerEvent` | string \| null                      | No       | The event type that triggers this automation (e.g., "message", "contact", "customer")                                         |
| `condition`    | `Record<string, string \| boolean>` | No       | A key-value map of conditions that must be met for the automation to execute. Values must be strings or booleans (no nesting) |
| `instructions` | string                              | Yes      | Natural language instructions describing what the automation should do                                                        |
| `createdBy`    | string (UUID)                       | No       | The user ID who created the automation                                                                                        |
| `enabled`      | boolean                             | No       | Whether the automation is enabled (defaults to true)                                                                          |

<Note>
  After creation, the automation is generated and evaluated asynchronously.
  System-managed fields like generated code, evaluation results, group
  metadata, and execution counters are populated by the platform — do not pass
  them in here, as they are overwritten or ignored.
</Note>

**Returns:** The created automation object.

***

### getAutomation

Get details of a specific automation by ID.

**Permission:** `automations:read`

**Parameters:**

| Name           | Type          | Required | Description                          |
| -------------- | ------------- | -------- | ------------------------------------ |
| `automationId` | string (UUID) | Yes      | The ID of the automation to retrieve |

**Returns:** The automation object, or `null` if not found.

***

### listAutomations

List automations with pagination.

**Permission:** `automations:read`

**Parameters:**

| Name     | Type   | Required | Default | Description                                  |
| -------- | ------ | -------- | ------- | -------------------------------------------- |
| `limit`  | number | No       | 20      | Number of automations to return (1-100)      |
| `offset` | number | No       | 0       | Number of automations to skip for pagination |

**Returns:**

```json theme={null}
{
  "automations": [...],
  "count": 42,
  "limit": 20,
  "offset": 0
}
```

***

### updateAutomation

Update an existing automation - all fields are optional except `automationId`.

**Permission:** `automations:write`

**Parameters:**

| Name           | Type                                | Required | Description                                                            |
| -------------- | ----------------------------------- | -------- | ---------------------------------------------------------------------- |
| `automationId` | string (UUID)                       | Yes      | The ID of the automation to update                                     |
| `name`         | string                              | No       | Update the automation name                                             |
| `description`  | string                              | No       | Update the description                                                 |
| `triggerEvent` | string                              | No       | Update the trigger event                                               |
| `condition`    | `Record<string, string \| boolean>` | No       | Update the conditions. Values must be strings or booleans (no nesting) |
| `instructions` | string                              | No       | Update the instructions                                                |
| `createdBy`    | string (UUID)                       | No       | Update the creator                                                     |
| `enabled`      | boolean                             | No       | Enable or disable the automation                                       |

**Returns:** The updated automation object.

***

### deleteAutomation

Delete an automation (soft delete).

**Permission:** `automations:delete`

**Parameters:**

| Name           | Type          | Required | Description                        |
| -------------- | ------------- | -------- | ---------------------------------- |
| `automationId` | string (UUID) | Yes      | The ID of the automation to delete |

**Returns:** The deleted automation object.

***

## Executions

Tools for inspecting individual automation executions and their history.

### getAutomationExecution

Get details of a specific automation execution by ID.

**Permission:** `automations.executions:read`

**Parameters:**

| Name          | Type          | Required | Description                                    |
| ------------- | ------------- | -------- | ---------------------------------------------- |
| `executionId` | string (UUID) | Yes      | The ID of the automation execution to retrieve |

**Returns:** The automation execution object, or `null` if not found.

***

### listAutomationExecutions

List automation executions with pagination, optionally filtered by automation
ID.

**Permission:** `automations.executions:read`

**Parameters:**

| Name           | Type          | Required | Default | Description                                 |
| -------------- | ------------- | -------- | ------- | ------------------------------------------- |
| `automationId` | string (UUID) | No       | -       | Filter executions by automation ID          |
| `limit`        | number        | No       | 20      | Number of executions to return (1-100)      |
| `offset`       | number        | No       | 0       | Number of executions to skip for pagination |

**Returns:**

```json theme={null}
{
  "executions": [...],
  "count": 17,
  "limit": 20,
  "offset": 0
}
```

***

## Next Steps

<CardGroup cols={2}>
  <Card title="Contact Tools" icon="address-book" href="/mcp-server/tools/contacts">
    Manage contacts and their associated data
  </Card>

  <Card title="Authentication" icon="key" href="/mcp-server/authentication">
    Learn how MCP clients authenticate to the server
  </Card>
</CardGroup>