Skip to content

For the complete documentation index, see llms.txt.

Triggers

A trigger is an event that starts Promptless documentation work. Examples include a pull request opening, a message in a Slack thread, or an API call. When a trigger event arrives, Promptless reads it, decides whether your documentation needs an update, and creates a suggestion when it does.

Choose triggers by where the changes and requests your docs must keep up with first appear:

To start documentation workUse
While code changes are still in reviewGitHub PRs or GitLab merge requests
From commits that reach a branch without a pull request, such as hotfixesGitHub commits
From requests teammates or community members make in GitHub, Slack, or JiraGitHub issues, Slack, or Jira
On a Jira condition of your own, such as a ticket assigned to a docs ownerJira Automation
When a feature flag changes (beta)LaunchDarkly
From a CI/CD pipeline, a Zapier automation, or another system that can send HTTP requestsAPI
From your editor or chat app, with no API keyMCP
On a recurring schedule, such as a weekly check of release notes against the changelogSchedule

When a trigger event arrives:

  1. Promptless receives the event, such as a pull request opening or a message posted in a watched channel.
  2. Promptless reads the event’s content, such as code changes or a conversation, along with your connected context sources.
  3. Promptless decides whether the event needs a documentation update.
  4. If it does, Promptless creates documentation suggestions.

Promptless skips the pull requests and merge requests it opens, including documentation PRs in a repository that a trigger watches. To have Promptless act on one of these PRs, tag Promptless in a comment on the PR.

Add and edit triggers on the Triggers tab of the Configuration page, or in the triggers section of your promptless.yaml file. For each trigger, you set:

  • The repositories, channels, projects, or flags it watches.
  • Trigger-specific filters, such as directories or target branches.
  • How its suggestions publish, through a policy rule that names the trigger.

See the Configuration Reference for the complete YAML schema.

Connect a provider before you add its triggers

Section titled “Connect a provider before you add its triggers”

To add, rename, or modify a provider-backed trigger, first connect its provider on the Integrations page. Only organization administrators can connect integrations, so if you’re not an admin, ask one.

If you disconnect a provider, its triggers stay in your promptless.yaml and show as inactive until you reconnect it. You can remove an inactive trigger at any time. To edit or rename one, reconnect its provider first.

Connections are organization-wide, so disconnecting a provider affects every team’s triggers for it.

For how these states appear in the editor, see Provider connection and trigger availability. To check a connection, see Connection health.

When your publishing policies turn on automatic PR creation, Promptless opens a pull request in your documentation repository for each suggestion. For commit triggers, you can also turn on auto-merge, which merges those documentation PRs as soon as Promptless creates them.

Automatic PR creation works with every Git-hosted documentation platform.

When Promptless opens a documentation pull request, the PR description lists the trigger events that led to its changes. Reviewers can trace each update back to the pull request, message, or other event that prompted it.

The Triggers page in the dashboard lists the events that triggered Promptless and what came of each one. With no search or date range set, it shows the last 30 days. Use it to confirm Promptless caught a change, follow a long-running task, or find out why a change produced no suggestion. Each event reports its outcome: researching, suggestion created, suggestion updated, no suggestion, or suggestion closed.

Triggers page row list grouped under a Today header, each row showing the time, source icon, action verb, PR or thread reference, and headline, with a status pill on the right reporting the trigger's outcome

For each event, you can see the suggestions it created, updated, or closed, along with when the event arrived and when the run finished. To find older events, search your full trigger history by PR details, Slack thread topic, or task name. You can also set a From and To date range. To narrow the list, filter by Trigger Type. To show only events with or without suggestions, set Suggestion Activity to Suggestion Activity or No Suggestion Activity. The page reports how many events match the current filters. You can also group events by date or by event source.

Each trigger includes a research breakdown of what Promptless read before drafting or skipping documentation. It appears on the Triggers page and on the suggestion the trigger produced. Use it to check that Promptless worked from the right sources. The breakdown lists items in roughly the order the agent worked:

  • Source and documentation files the agent opened, webpages it fetched, and Slack threads it read.
  • Knowledge base files, such as contribution guidelines or style rules, each linked to the file in the Agent Knowledge Base editor.
  • Content and filename searches, each marked with whether it ran against your doc collection or the agent’s own working directory.
  • Research delegated to a specialized subagent, with the subagent type and how many tool calls it made.
  • Any of your own skills the agent used.

Backfill runs Promptless on pull requests that already exist. Use it to catch up on documentation for work that merged before a trigger was watching. It’s available on saved GitHub PR and GitLab merge request triggers. Any organization member can view a backfill’s status, progress, and the suggestions it produced. Only admins can launch one.

A backfill covers pull requests opened or merged in the window you choose, up to 1,000 per repository. It applies the same repository, topic, directory, and branch filters the trigger uses for live events. For a trigger scoped by repository topic, only repositories that carry a matching topic contribute pull requests.

For GitHub PR triggers that activate only on first approval, backfill also replays first approvals. The preview then includes open pull requests whose first approval landed within the window, even those opened before it. GitLab merge request triggers don’t replay approvals, so a first-approval GitLab trigger returns no backfill results.

To run a backfill:

  1. On the Triggers tab of the Configuration page, select Backfill suggestions… on the trigger.

  2. Choose Last 7 days, Last 14 days, or Last 30 days.

  3. Optional. To include pull requests that an earlier backfill of this trigger already processed, clear Skip previously submitted PRs. This option appears after the trigger’s first backfill.

  4. Select Preview, and check the pull requests the trigger matches.

  5. Select Launch backfill.

Progress updates as the run works through the list.