Skip to content

feat(API): add status filter to webhook deliveries list - #1317

Merged
Manuel Boy (docstun) merged 2 commits into
mainfrom
feat/webhook-deliveries-status-filter
Oct 13, 2026
Merged

Manuel Boy (docstun) merged 2 commits into
mainfrom
feat/webhook-deliveries-status-filter

Conversation

@docstun

@docstun Manuel Boy (docstun) commented Oct 13, 2026 •

Copy link
Copy Markdown
Member

Documents the new optional status query parameter on GET /projects/{project_id}/webhooks/{webhook_id}/deliveries.

  • success: deliveries with a 2xx response code or a soft error
  • failed: all other deliveries, including exceptions and timeouts without a response code
  • An invalid value returns 400, which is already listed for this operation

Changes:

  • New shared parameter webhook_delivery_status in parameters.yaml (sent as status)
  • Referenced from paths/webhook_deliveries/index.yaml
  • Regenerated doc/compiled.json

make lint passes.

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown
Contributor

API changelog (oasdiff)

Doc-only edits (descriptions, examples) do not appear here.

1 changes: 0 error, 0 warning, 1 info
info	[new-optional-request-parameter] at doc/compiled.json
	in API GET /projects/{project_id}/webhooks/{webhook_id}/deliveries
		added the new optional `query` request parameter `status`

@docstun
Manuel Boy (docstun) requested review from jablan and a balanced review from Copilot October 13, 2026 13:34
@docstun
Manuel Boy (docstun) marked this pull request as ready for review October 13, 2026 13:35

Copilot AI 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.

🟢 Approval recommended

The source and compiled specifications consistently document the valid filter values and endpoint reference.

0 open findings

What changed in this PR

Documents the optional webhook delivery status filter and updates the compiled OpenAPI specification.

Changes:

  • Defines status with success and failed values.
  • Adds the parameter to the webhook deliveries list endpoint.
  • Regenerates the compiled specification.
File Description
parameters.yaml Defines the reusable status parameter.
paths/​webhook_deliveries/​index.yaml Adds the filter to the list operation.
doc/​compiled.json Includes the generated parameter and reference.

🧠 Review effort: Balanced


💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread parameters.yaml Outdated
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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.

3 participants