> For the complete documentation index, see [llms.txt](https://docs.keeper.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.keeper.io/keeperpam/endpoint-privilege-manager/custom-tooling/jobs-and-plugins.md).

# Jobs & Plugins

<figure><img src="https://762006384-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MJXOXEifAmpyvNVL1to%2Fuploads%2FfmojJ80zdqBeQjgXGy6H%2Fimage.png?alt=media&amp;token=bbe50982-559a-48ce-bcfb-616a27570ae3" alt=""><figcaption></figcaption></figure>

Jobs and plugins are how Keeper EPM does work on an endpoint, and how you extend it. This page explains what each one is and what the pages beneath it cover. Use it to decide where to start.

***

## What Jobs Are

A job is a named, repeatable piece of automation that the Keeper EPM agent runs on an endpoint. A job is made of one or more tasks. A task is a single step, such as running a program, calling a web service or publishing a message, and the agent runs a job's tasks in order.

A job starts when its trigger fires. A trigger can be an event, the agent starting up, a schedule, or an on-demand request through the agent's local API. A job can also have conditions, so it runs only on certain operating systems or only when the endpoint is in a given state.

Jobs are short-lived. A job task starts, does its work and exits, and the agent records the result. The agent itself uses jobs for policy controls such as MFA, justification and approval prompts, for starting applications elevated, and for collecting inventory. You can add your own jobs to run scans, reports, health checks or maintenance tasks on a schedule or in response to events.

## What Plugins Are

A plugin is a component that runs as part of the agent. Plugins stay running. The agent starts them, monitors them and restarts them as part of its own lifecycle. Each plugin has one responsibility, such as talking to Keeper, evaluating policies, writing logs or showing the user interface. Most plugins ship with the product.

You can also register your own plugin when your tool needs to stay running and react to events, instead of running once and exiting.

***

## Jobs or Plugins

<table><thead><tr><th width="156"></th><th>Job</th><th>Plugin</th></tr></thead><tbody><tr><td><strong>How it runs</strong></td><td>Starts, does its work and exits</td><td>Stays running while the agent runs</td></tr><tr><td><strong>What starts it</strong></td><td>A trigger: an event, startup, a schedule or a request</td><td>The agent, according to the plugin's startup settings</td></tr><tr><td><strong>Best for</strong></td><td>Scans, reports, checks and maintenance tasks</td><td>Long-running services and components that respond to events</td></tr><tr><td><strong>Registered with</strong></td><td>A job file</td><td>A plugin file</td></tr></tbody></table>

Jobs and plugins share the same supporting pieces. Both are registered with the agent in the same way, both read settings from the same place, and both use MQTT topic permissions to control which messages they can send and receive.

***

## What Is on the Pages Beneath This One

### Reference Pages

* [**Job & Plugin Registration**](https://docs.keeper.io/keeperpam/endpoint-privilege-manager/custom-tooling/jobs-and-plugins/plugin-and-job-registration.md): How the agent discovers, validates and loads job files and plugin files.
* [**Job & Plugin Settings Keys**](https://docs.keeper.io/keeperpam/endpoint-privilege-manager/custom-tooling/jobs-and-plugins/job-and-plugin-settings-keys.md): The settings that control jobs and plugins, and how the agent merges them from different sources.
* [**Job & Plugin MQTT Topic Permissions**](https://docs.keeper.io/keeperpam/endpoint-privilege-manager/custom-tooling/jobs-and-plugins/job-and-plugin-mqtt-topic-permissions.md): How a job or plugin declares the MQTT topics it may use, and how the broker enforces them.

### Custom Job Guide

* [**Custom Job Guide**](https://docs.keeper.io/keeperpam/endpoint-privilege-manager/custom-tooling/jobs-and-plugins/custom-job-guide.md): A step-by-step guide to running your own executable as a job task. It covers building and deploying the binary, writing the job file, and logging through MQTT.
  * [**Jobs Reference**](https://docs.keeper.io/keeperpam/endpoint-privilege-manager/custom-tooling/jobs-and-plugins/custom-job-guide/jobs-reference.md): The precise details behind jobs: the default jobs that ship with the agent, the job definition and format, and how to run jobs from the command line with the KeeperAdminCLI run guide.
  * [**Job Examples**](https://docs.keeper.io/keeperpam/endpoint-privilege-manager/custom-tooling/jobs-and-plugins/custom-job-guide/job-examples.md): Ready-to-use job files for common cases, including event-triggered, scheduled, startup, minimal per-platform and security tool health check jobs.

### Custom Plugin Guide

* [**Custom Plugin Guide**](https://docs.keeper.io/keeperpam/endpoint-privilege-manager/custom-tooling/jobs-and-plugins/custom-plugin-guide.md): A step-by-step guide to registering your own executable as a managed plugin. It covers the plugin file, how the agent starts and monitors it, and how it communicates.
  * [**Plugins Reference**](https://docs.keeper.io/keeperpam/endpoint-privilege-manager/custom-tooling/jobs-and-plugins/custom-plugin-guide/plugins-reference.md): The precise details behind plugins: plugin and task settings and the redirect capability that plugins use to reroute process launches.
  * [**Plugin Examples**](https://docs.keeper.io/keeperpam/endpoint-privilege-manager/custom-tooling/jobs-and-plugins/custom-plugin-guide/plugin-examples.md): Ready-to-use plugin files for common cases, including minimal per-platform plugins, command and response over MQTT, manual start, the Redirect Evaluator and the Windows install launcher.

***

## Where to Start

* To run something on a schedule, at startup or in response to an event, start with the [**Custom Job Guide**](https://docs.keeper.io/keeperpam/endpoint-privilege-manager/custom-tooling/jobs-and-plugins/custom-job-guide.md).
* To run a component that stays running alongside the agent, start with the [**Custom Plugin Guide**](https://docs.keeper.io/keeperpam/endpoint-privilege-manager/custom-tooling/jobs-and-plugins/custom-plugin-guide.md).
* To look up exact fields, settings or defaults, use the reference pages and the [**Jobs Reference**](https://docs.keeper.io/keeperpam/endpoint-privilege-manager/custom-tooling/jobs-and-plugins/custom-job-guide/jobs-reference.md) and [**Plugins Reference**](https://docs.keeper.io/keeperpam/endpoint-privilege-manager/custom-tooling/jobs-and-plugins/custom-plugin-guide/plugins-reference.md).
* To copy a working starting point, use the [**Job Examples**](https://docs.keeper.io/keeperpam/endpoint-privilege-manager/custom-tooling/jobs-and-plugins/custom-job-guide/job-examples.md) and [**Plugin Examples**](https://docs.keeper.io/keeperpam/endpoint-privilege-manager/custom-tooling/jobs-and-plugins/custom-plugin-guide/plugin-examples.md).

If you have not read the [**Custom Tooling Overview**](https://docs.keeper.io/keeperpam/endpoint-privilege-manager/custom-tooling.md) yet, read it first. It defines the key terms and explains how the pieces connect.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.keeper.io/keeperpam/endpoint-privilege-manager/custom-tooling/jobs-and-plugins.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
