Interface: GithubWebhookStreamOptions
Defined in: github/src/builders/github-webhook-stream-options.ts:9
Configuration options for the GitHub webhook event stream builder (github.webhookStream).
Defines the optional repository filter, local HTTP listener port and route path, HMAC-SHA256 webhook secret, and subscribed GitHub webhook event names.
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
events | readonly | readonly string[] | Subscribed GitHub webhook event names (such as 'pull_request.closed'). | github/src/builders/github-webhook-stream-options.ts:19 |
path? | readonly | string | Optional HTTP route path for incoming webhook deliveries (defaults to '/webhooks/github'). | github/src/builders/github-webhook-stream-options.ts:15 |
port? | readonly | number | Optional local TCP listener port (defaults to 3000). | github/src/builders/github-webhook-stream-options.ts:13 |
repo? | readonly | string | Optional GitHub repository slug in owner/repo format used to filter webhook deliveries. | github/src/builders/github-webhook-stream-options.ts:11 |
secret | readonly | string | EnvRef | GitHub webhook HMAC-SHA256 secret string or symbolic P.env(...) reference. | github/src/builders/github-webhook-stream-options.ts:17 |