Repository navigation
Outbound: endpoint listing across consumers, health, delivery filters (v0.3.0) - #2
Merged
Merged
Conversation
Regenerate the low-level client from the updated spec (make openapi) and
expose the new operations on the ergonomic surface:
- relay.outbound.endpoints.listAll({ state, consumer, limit, offset })
-> GET /v1/outbound/endpoints (failing endpoints longest failing first)
- relay.outbound.health() -> GET /v1/outbound/health
- OutboundEndpoint.stats: attempts and failures over the last 24 hours
Adds OutboundEndpointStats, OutboundHealth and
ListAllOutboundEndpointsParams types, a reportFailingEndpoints example
(run by the tests) and README docs.
Bugbot couldn't run - usage limit reachedBugbot is counted against Cursor usage for this user or team, and this run hit a usage or spend limit. A user or team admin can review and increase usage limits in the Cursor dashboard. (requestId: serverGenReqId_55423825-b4a1-41aa-85fb-1d09b62cb079) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Brings the SDK in line with the updated outbound API and bumps the package to 0.3.0. The outbound webhooks surface from #1 was never published (npm's latest is 0.2.0), so it ships in this release too.
Outbound additions
relay.outbound.endpoints.listAll({ state, consumer, limit, offset })callsGET /v1/outbound/endpointsand lists endpoints across all consumers. Thestatefilter returns failing endpoints first, longest failing at the top.relay.outbound.health()callsGET /v1/outbound/healthand returns endpoint counts by state plus attempts and failures over the last 24 hours.OutboundEndpoint.statsholds the endpoint's attempts and failures over the last 24 hours.ListOutboundDeliveriesParamsacceptsstatus(sent/failed/stalled/received/rejected),event_typeandmessage_id.OutboundMessage.unavailable_endpoint_idsis set bymessages.getwhen some deliveries could not be read in time.OutboundDeliveryAttempt.response_bodyis base64-encoded.Other
RELAY_BASE_URLsets the API address from the environment, for self-hosted or local development. An explicitbaseUrlstill wins.OutboundEndpointStats,OutboundHealth,ListAllOutboundEndpointsParams.reportFailingEndpointsexample is run by the tests, and the README documents the new calls.Release v0.3.0bumps package.json and package-lock. After merge, publishing av0.3.0GitHub release runsnpm-publish.yml, which publishes via trusted publishing.Verified locally:
npm ci,npm run typecheck,npm test(66 passed),npm run build.🤖 Generated with Claude Code
Note
Low Risk
Additive SDK surface and env-based base URL; no changes to auth or existing call signatures beyond new optional fields.
Overview
Releases @webhookrelay/sdk v0.3.0 with outbound observability and config tweaks on top of the regenerated OpenAPI client.
Outbound: Adds
relay.outbound.health()for account-wide endpoint counts and 24h delivery stats, andrelay.outbound.endpoints.listAll({ state, consumer, limit, offset })to page endpoints across consumers (failing endpoints ordered longest-failing first).OutboundEndpointnow exposes optionalstatson list/get; delivery listing acceptsstatus,event_type, andmessage_idfilters; message detail can includeunavailable_endpoint_ids. Docs andexamples/outbound.tsadd a failing-endpoints report; swagger/generated types pick up related API shapes (including outbound access endpoints in the low-level client).Config:
RELAY_BASE_URLresolves the API host from the environment (explicitbaseUrlstill wins), documented in the README.Reviewed by Cursor Bugbot for commit 8050471. Configure here.