Skip to content

Interface: GithubWebhookStreamNode<TEvent> ​

Defined in: ast/domain/github-webhook-stream-node.ts:12

Passive AST node configuring a GitHub webhook event stream source (github.webhookStream).

Verifies incoming X-Hub-Signature-256 HMAC signatures using secret and filters webhook deliveries by repo and subscribed events.

Extends ​

Type Parameters ​

Type ParameterDefault typeDescription
TEventunknownRaw webhook event payload type.

Properties ​

PropertyModifierTypeDescriptionInherited fromDefined in
__eventBrand?readonlyTEventPhantom type brand preserving the stream event payload type.BaseStreamSourceASTNode.__eventBrandast/base/base-stream-source-ast-node.ts:14
eventsreadonlyreadonly string[]Subscribed GitHub webhook event names (such as 'pull_request.closed').-ast/domain/github-webhook-stream-node.ts:23
path?readonlystringOptional HTTP webhook route path (defaults to '/webhooks/github').-ast/domain/github-webhook-stream-node.ts:19
port?readonlynumberOptional HTTP listener port (defaults to 3000).-ast/domain/github-webhook-stream-node.ts:17
repo?readonlystringOptional GitHub repository slug in owner/repo format used to filter incoming events.-ast/domain/github-webhook-stream-node.ts:15
secretreadonlystring | EnvRefWebhook HMAC secret string or symbolic EnvRef.-ast/domain/github-webhook-stream-node.ts:21
typereadonly"github:webhook-stream"Unique string-literal discriminant of the stream source node.BaseStreamSourceASTNode.typeast/base/base-stream-source-ast-node.ts:12

Released under the MIT License.