Skip to content

Interface: GithubWebhookStreamNode<TEvent> ​

Defined in: core/dist/ast/domain/github-webhook-stream-node.d.ts:11

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.__eventBrandcore/dist/ast/base/base-stream-source-ast-node.d.ts:14
eventsreadonlyreadonly string[]Subscribed GitHub webhook event names (such as 'pull_request.closed').-core/dist/ast/domain/github-webhook-stream-node.d.ts:21
path?readonlystringOptional HTTP webhook route path (defaults to '/webhooks/github').-core/dist/ast/domain/github-webhook-stream-node.d.ts:17
port?readonlynumberOptional HTTP listener port (defaults to 3000).-core/dist/ast/domain/github-webhook-stream-node.d.ts:15
repo?readonlystringOptional GitHub repository slug in owner/repo format used to filter incoming events.-core/dist/ast/domain/github-webhook-stream-node.d.ts:13
secretreadonlystring | EnvRefWebhook HMAC secret string or symbolic EnvRef.-core/dist/ast/domain/github-webhook-stream-node.d.ts:19
typereadonly"github:webhook-stream"Unique string-literal discriminant of the stream source node.BaseStreamSourceASTNode.typecore/dist/ast/base/base-stream-source-ast-node.d.ts:12

Released under the MIT License.