Skip to content

docs: add webhooks and waitpoints API key presets - #5032

Open
mintlify[bot] wants to merge 2 commits into
mainfrom
autopilot/apikeys-waitpoint-presets
Open

mintlify[bot] wants to merge 2 commits into
mainfrom
autopilot/apikeys-waitpoint-presets

Conversation

@mintlify

@mintlify mintlify Bot commented Oct 16, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds the Webhooks only and Waitpoints only presets to the API key access presets table. It also updates the Observer and Operator rows to include errors and webhooks.

The New API key dialog now lists both presets. Waitpoint token routes now authorize by scope, so a Waitpoints only key can create, list and retrieve waitpoint tokens.

Based on feat(webapp): webhook and waitpoint access for scoped API keys, which added the scopes to the access summary and to the waitpoint token routes.

Docs only. Mark ready for review to merge.

@mintlify
mintlify Bot requested a review from ericallam October 16, 2026 10:14
@changeset-bot

changeset-bot Bot commented Oct 16, 2026 •

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 22d1c29

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai

coderabbitai Bot commented Oct 16, 2026 •

Copy link
Copy Markdown
Contributor

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration
  • Configuration used: Repository UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 44e1e8b4-7240-4317-94ad-9ea829a35468

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@ericallam
ericallam marked this pull request as ready for review October 16, 2026 10:15

@devin-ai-integration devin-ai-integration Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Devin Review found 1 potential issue.

Devin Review

Comment thread docs/apikeys.mdx Outdated
| **Operator** | Observe and operate on runs and queues, and trigger tasks |
| **Observer** | Read runs, tasks, batches, logs, traces, queues, errors, and webhooks |
| **Operator** | Observe and operate on runs, queues, errors, and webhooks, and trigger tasks |
| **Webhooks only** | Read and write [webhooks](/webhooks/overview), which are in private beta. No task or run access |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔍 Webhook preset has workflow exceptions

Webhooks only cannot replay deliveries that trigger tasks or create webhook waiters. Those operations require task or waitpoint scopes beyond webhook access.

Devin Review


Was this helpful? React with 👍 or 👎 to provide feedback.

@ericallam

Copy link
Copy Markdown
Member

@claude address ci review comments please

@claude

claude Bot commented Oct 16, 2026 •

Copy link
Copy Markdown
Contributor

Claude finished @ericallam's task in 53s —— View job


Addressing CI Review Comments

  • Read the current docs file and understand the review comment
  • Update the Webhooks only preset description to clarify limitations
  • Commit and push the changes

Addressed the Devin review comment by updating the Webhooks only preset description to clarify that replaying deliveries that trigger tasks and creating webhook waiters require additional task or waitpoint scopes.
·

Replaying deliveries that trigger tasks and creating webhook waiters
require additional task or waitpoint scopes beyond webhook access.

Co-authored-by: Eric Allam <534+ericallam@users.noreply.github.com>

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant