Application | probot

The app parameter available to ApplicationFunctions

property: {logger} log - A logger

Hierarchy

Application

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Application(options?: Options): Application

- Defined in src/application.ts:46
Parameters
- Optional options: Options
Returns Application

Properties

app

app: OctokitApp

cache

cache: Cache

events

events: EventEmitter

log

log: LoggerWithTarget

router

router: express.Router

Methods

load

load(appFn: ApplicationFunction | ApplicationFunction[]): Application

- Defined in src/application.ts:64
Loads an ApplicationFunction into the current Application

Parameters
- appFn: ApplicationFunction | ApplicationFunction[]
  
  Probot application function to load
Returns Application

on

on(event: "check_run" | "check_run.completed" | "check_run.created" | "check_run.requested_action" | "check_run.rerequested", callback: OnCallback<Webhooks.WebhookPayloadCheckRun>): void
on(event: "check_suite" | "check_suite.completed" | "check_suite.requested" | "check_suite.rerequested", callback: OnCallback<Webhooks.WebhookPayloadCheckSuite>): void
on(event: "commit_comment" | "commit_comment.created", callback: OnCallback<Webhooks.WebhookPayloadCommitComment>): void
on(event: "create", callback: OnCallback<Webhooks.WebhookPayloadCreate>): void
on(event: "delete", callback: OnCallback<Webhooks.WebhookPayloadDelete>): void
on(event: "deployment", callback: OnCallback<Webhooks.WebhookPayloadDeployment>): void
on(event: "deployment_status", callback: OnCallback<Webhooks.WebhookPayloadDeploymentStatus>): void
on(event: "fork", callback: OnCallback<Webhooks.WebhookPayloadFork>): void
on(event: "github_app_authorization", callback: OnCallback<Webhooks.WebhookPayloadGithubAppAuthorization>): void
on(event: "gollum", callback: OnCallback<Webhooks.WebhookPayloadGollum>): void
on(event: "installation" | "installation.created" | "installation.deleted", callback: OnCallback<Webhooks.WebhookPayloadInstallation>): void
on(event: "installation_repositories" | "installation_repositories.added" | "installation_repositories.removed", callback: OnCallback<Webhooks.WebhookPayloadInstallationRepositories>): void
on(event: "issue_comment" | "issue_comment.created" | "issue_comment.deleted" | "issue_comment.edited", callback: OnCallback<Webhooks.WebhookPayloadIssueComment>): void
on(event: "issues" | "issues.assigned" | "issues.closed" | "issues.deleted" | "issues.demilestoned" | "issues.edited" | "issues.labeled" | "issues.milestoned" | "issues.opened" | "issues.reopened" | "issues.transferred" | "issues.unassigned" | "issues.unlabeled", callback: OnCallback<Webhooks.WebhookPayloadIssues>): void
on(event: "label" | "label.created" | "label.deleted" | "label.edited", callback: OnCallback<Webhooks.WebhookPayloadLabel>): void
on(event: "marketplace_purchase" | "marketplace_purchase.cancelled" | "marketplace_purchase.changed" | "marketplace_purchase.pending_change" | "marketplace_purchase.pending_change_cancelled" | "marketplace_purchase.purchased", callback: OnCallback<Webhooks.WebhookPayloadMarketplacePurchase>): void
on(event: "member" | "member.added" | "member.deleted" | "member.edited", callback: OnCallback<Webhooks.WebhookPayloadMember>): void
on(event: "membership" | "membership.added" | "membership.removed", callback: OnCallback<Webhooks.WebhookPayloadMembership>): void
on(event: "milestone" | "milestone.closed" | "milestone.created" | "milestone.deleted" | "milestone.edited" | "milestone.opened", callback: OnCallback<Webhooks.WebhookPayloadMilestone>): void
on(event: "organization" | "organization.member_added" | "organization.member_invited" | "organization.member_removed", callback: OnCallback<Webhooks.WebhookPayloadOrganization>): void
on(event: "org_block" | "org_block.blocked" | "org_block.unblocked", callback: OnCallback<Webhooks.WebhookPayloadOrgBlock>): void
on(event: "page_build", callback: OnCallback<Webhooks.WebhookPayloadPageBuild>): void
on(event: "project_card" | "project_card.converted" | "project_card.created" | "project_card.deleted" | "project_card.edited" | "project_card.moved", callback: OnCallback<Webhooks.WebhookPayloadProjectCard>): void
on(event: "project_column" | "project_column.created" | "project_column.deleted" | "project_column.edited" | "project_column.moved", callback: OnCallback<Webhooks.WebhookPayloadProjectColumn>): void
on(event: "project" | "project.closed" | "project.created" | "project.deleted" | "project.edited" | "project.reopened", callback: OnCallback<Webhooks.WebhookPayloadProject>): void
on(event: "public", callback: OnCallback<Webhooks.WebhookPayloadPublic>): void
on(event: "pull_request" | "pull_request.assigned" | "pull_request.closed" | "pull_request.edited" | "pull_request.labeled" | "pull_request.opened" | "pull_request.reopened" | "pull_request.review_request_removed" | "pull_request.review_requested" | "pull_request.unassigned" | "pull_request.unlabeled" | "pull_request.synchronize", callback: OnCallback<Webhooks.WebhookPayloadPullRequest>): void
on(event: "pull_request_review" | "pull_request_review.dismissed" | "pull_request_review.edited" | "pull_request_review.submitted", callback: OnCallback<Webhooks.WebhookPayloadPullRequestReview>): void
on(event: "pull_request_review_comment" | "pull_request_review_comment.created" | "pull_request_review_comment.deleted" | "pull_request_review_comment.edited", callback: OnCallback<Webhooks.WebhookPayloadPullRequestReviewComment>): void
on(event: "push", callback: OnCallback<Webhooks.WebhookPayloadPush>): void
on(event: "release" | "release.published", callback: OnCallback<Webhooks.WebhookPayloadRelease>): void
on(event: "repository" | "repository.archived" | "repository.created" | "repository.deleted" | "repository.privatized" | "repository.publicized" | "repository.unarchived", callback: OnCallback<Webhooks.WebhookPayloadRepository>): void
on(event: "repository_import", callback: OnCallback<Webhooks.WebhookPayloadRepositoryImport>): void
on(event: "repository_vulnerability_alert" | "repository_vulnerability_alert.create" | "repository_vulnerability_alert.dismiss" | "repository_vulnerability_alert.resolve", callback: OnCallback<Webhooks.WebhookPayloadRepositoryVulnerabilityAlert>): void
on(event: "security_advisory" | "security_advisory.performed" | "security_advisory.published" | "security_advisory.updated", callback: OnCallback<Webhooks.WebhookPayloadSecurityAdvisory>): void
on(event: "status", callback: OnCallback<Webhooks.WebhookPayloadStatus>): void
on(event: "team" | "team.added_to_repository" | "team.created" | "team.deleted" | "team.edited" | "team.removed_from_repository", callback: OnCallback<Webhooks.WebhookPayloadTeam>): void
on(event: "team_add", callback: OnCallback<Webhooks.WebhookPayloadTeamAdd>): void
on(event: "watch" | "watch.started", callback: OnCallback<Webhooks.WebhookPayloadWatch>): void
on(eventName: string | string[], callback: OnCallback<any>): void

- Defined in src/application.ts:141
Listen for GitHub webhooks, which are fired for almost every significant action that users take on GitHub.

Parameters
- event: "check_run" | "check_run.completed" | "check_run.created" | "check_run.requested_action" | "check_run.rerequested"
  the name of the GitHub webhook event. Most events also include an "action". For example, the * issues event has actions of assigned, unassigned, labeled, unlabeled, opened, edited, milestoned, demilestoned, closed, and reopened. Often, your bot will only care about one type of action, so you can append it to the event name with a ., like issues.closed.
```
app.on('push', context => {
  // Code was just pushed.
});

app.on('issues.opened', context => {
  // An issue was just opened.
});
```
- callback: OnCallback<Webhooks.WebhookPayloadCheckRun>
  
  a function to call when the webhook is received.
Returns void
- Defined in src/application.ts:151
Parameters
- event: "check_suite" | "check_suite.completed" | "check_suite.requested" | "check_suite.rerequested"
- callback: OnCallback<Webhooks.WebhookPayloadCheckSuite>
Returns void
- Defined in src/application.ts:160
Parameters
- event: "commit_comment" | "commit_comment.created"
- callback: OnCallback<Webhooks.WebhookPayloadCommitComment>
Returns void
- Defined in src/application.ts:165
Parameters
- event: "create"
- callback: OnCallback<Webhooks.WebhookPayloadCreate>
Returns void
- Defined in src/application.ts:170
Parameters
- event: "delete"
- callback: OnCallback<Webhooks.WebhookPayloadDelete>
Returns void
- Defined in src/application.ts:175
Parameters
- event: "deployment"
- callback: OnCallback<Webhooks.WebhookPayloadDeployment>
Returns void
- Defined in src/application.ts:180
Parameters
- event: "deployment_status"
- callback: OnCallback<Webhooks.WebhookPayloadDeploymentStatus>
Returns void
- Defined in src/application.ts:185
Parameters
- event: "fork"
- callback: OnCallback<Webhooks.WebhookPayloadFork>
Returns void
- Defined in src/application.ts:190
Parameters
- event: "github_app_authorization"
- callback: OnCallback<Webhooks.WebhookPayloadGithubAppAuthorization>
Returns void
- Defined in src/application.ts:195
Parameters
- event: "gollum"
- callback: OnCallback<Webhooks.WebhookPayloadGollum>
Returns void
- Defined in src/application.ts:200
Parameters
- event: "installation" | "installation.created" | "installation.deleted"
- callback: OnCallback<Webhooks.WebhookPayloadInstallation>
Returns void
- Defined in src/application.ts:205
Parameters
- event: "installation_repositories" | "installation_repositories.added" | "installation_repositories.removed"
- callback: OnCallback<Webhooks.WebhookPayloadInstallationRepositories>
Returns void
- Defined in src/application.ts:213
Parameters
- event: "issue_comment" | "issue_comment.created" | "issue_comment.deleted" | "issue_comment.edited"
- callback: OnCallback<Webhooks.WebhookPayloadIssueComment>
Returns void
- Defined in src/application.ts:222
Parameters
- event: "issues" | "issues.assigned" | "issues.closed" | "issues.deleted" | "issues.demilestoned" | "issues.edited" | "issues.labeled" | "issues.milestoned" | "issues.opened" | "issues.reopened" | "issues.transferred" | "issues.unassigned" | "issues.unlabeled"
- callback: OnCallback<Webhooks.WebhookPayloadIssues>
Returns void
- Defined in src/application.ts:240
Parameters
- event: "label" | "label.created" | "label.deleted" | "label.edited"
- callback: OnCallback<Webhooks.WebhookPayloadLabel>
Returns void
- Defined in src/application.ts:245
Parameters
- event: "marketplace_purchase" | "marketplace_purchase.cancelled" | "marketplace_purchase.changed" | "marketplace_purchase.pending_change" | "marketplace_purchase.pending_change_cancelled" | "marketplace_purchase.purchased"
- callback: OnCallback<Webhooks.WebhookPayloadMarketplacePurchase>
Returns void
- Defined in src/application.ts:256
Parameters
- event: "member" | "member.added" | "member.deleted" | "member.edited"
- callback: OnCallback<Webhooks.WebhookPayloadMember>
Returns void
- Defined in src/application.ts:261
Parameters
- event: "membership" | "membership.added" | "membership.removed"
- callback: OnCallback<Webhooks.WebhookPayloadMembership>
Returns void
- Defined in src/application.ts:266
Parameters
- event: "milestone" | "milestone.closed" | "milestone.created" | "milestone.deleted" | "milestone.edited" | "milestone.opened"
- callback: OnCallback<Webhooks.WebhookPayloadMilestone>
Returns void
- Defined in src/application.ts:277
Parameters
- event: "organization" | "organization.member_added" | "organization.member_invited" | "organization.member_removed"
- callback: OnCallback<Webhooks.WebhookPayloadOrganization>
Returns void
- Defined in src/application.ts:286
Parameters
- event: "org_block" | "org_block.blocked" | "org_block.unblocked"
- callback: OnCallback<Webhooks.WebhookPayloadOrgBlock>
Returns void
- Defined in src/application.ts:291
Parameters
- event: "page_build"
- callback: OnCallback<Webhooks.WebhookPayloadPageBuild>
Returns void
- Defined in src/application.ts:296
Parameters
- event: "project_card" | "project_card.converted" | "project_card.created" | "project_card.deleted" | "project_card.edited" | "project_card.moved"
- callback: OnCallback<Webhooks.WebhookPayloadProjectCard>
Returns void
- Defined in src/application.ts:307
Parameters
- event: "project_column" | "project_column.created" | "project_column.deleted" | "project_column.edited" | "project_column.moved"
- callback: OnCallback<Webhooks.WebhookPayloadProjectColumn>
Returns void
- Defined in src/application.ts:317
Parameters
- event: "project" | "project.closed" | "project.created" | "project.deleted" | "project.edited" | "project.reopened"
- callback: OnCallback<Webhooks.WebhookPayloadProject>
Returns void
- Defined in src/application.ts:328
Parameters
- event: "public"
- callback: OnCallback<Webhooks.WebhookPayloadPublic>
Returns void
- Defined in src/application.ts:333
Parameters
- event: "pull_request" | "pull_request.assigned" | "pull_request.closed" | "pull_request.edited" | "pull_request.labeled" | "pull_request.opened" | "pull_request.reopened" | "pull_request.review_request_removed" | "pull_request.review_requested" | "pull_request.unassigned" | "pull_request.unlabeled" | "pull_request.synchronize"
- callback: OnCallback<Webhooks.WebhookPayloadPullRequest>
Returns void
- Defined in src/application.ts:350
Parameters
- event: "pull_request_review" | "pull_request_review.dismissed" | "pull_request_review.edited" | "pull_request_review.submitted"
- callback: OnCallback<Webhooks.WebhookPayloadPullRequestReview>
Returns void
- Defined in src/application.ts:359
Parameters
- event: "pull_request_review_comment" | "pull_request_review_comment.created" | "pull_request_review_comment.deleted" | "pull_request_review_comment.edited"
- callback: OnCallback<Webhooks.WebhookPayloadPullRequestReviewComment>
Returns void
- Defined in src/application.ts:368
Parameters
- event: "push"
- callback: OnCallback<Webhooks.WebhookPayloadPush>
Returns void
- Defined in src/application.ts:373
Parameters
- event: "release" | "release.published"
- callback: OnCallback<Webhooks.WebhookPayloadRelease>
Returns void
- Defined in src/application.ts:378
Parameters
- event: "repository" | "repository.archived" | "repository.created" | "repository.deleted" | "repository.privatized" | "repository.publicized" | "repository.unarchived"
- callback: OnCallback<Webhooks.WebhookPayloadRepository>
Returns void
- Defined in src/application.ts:390
Parameters
- event: "repository_import"
- callback: OnCallback<Webhooks.WebhookPayloadRepositoryImport>
Returns void
- Defined in src/application.ts:395
Parameters
- event: "repository_vulnerability_alert" | "repository_vulnerability_alert.create" | "repository_vulnerability_alert.dismiss" | "repository_vulnerability_alert.resolve"
- callback: OnCallback<Webhooks.WebhookPayloadRepositoryVulnerabilityAlert>
Returns void
- Defined in src/application.ts:404
Parameters
- event: "security_advisory" | "security_advisory.performed" | "security_advisory.published" | "security_advisory.updated"
- callback: OnCallback<Webhooks.WebhookPayloadSecurityAdvisory>
Returns void
- Defined in src/application.ts:413
Parameters
- event: "status"
- callback: OnCallback<Webhooks.WebhookPayloadStatus>
Returns void
- Defined in src/application.ts:418
Parameters
- event: "team" | "team.added_to_repository" | "team.created" | "team.deleted" | "team.edited" | "team.removed_from_repository"
- callback: OnCallback<Webhooks.WebhookPayloadTeam>
Returns void
- Defined in src/application.ts:429
Parameters
- event: "team_add"
- callback: OnCallback<Webhooks.WebhookPayloadTeamAdd>
Returns void
- Defined in src/application.ts:434
Parameters
- event: "watch" | "watch.started"
- callback: OnCallback<Webhooks.WebhookPayloadWatch>
Returns void
- Defined in src/application.ts:438
Parameters
- eventName: string | string[]
- callback: OnCallback<any>
Returns void

receive

receive(event: WebhookEvent<any>): Promise<[void, void, void]>

- Defined in src/application.ts:74
Parameters
- event: WebhookEvent<any>
Returns Promise<[void, void, void]>

route

route(path?: undefined | string): express.Router

Get an express router that can be used to expose HTTP endpoints

module.exports = app => {
  // Get an express router to expose new HTTP endpoints
  const route = app.route('/my-app');

  // Use any middleware
  route.use(require('express').static(__dirname + '/public'));

  // Add a new route
  route.get('/hello-world', (req, res) => {
    res.end('Hello World');
  });
};

Parameters

Optional path: undefined | string

the prefix for the routes

Returns express.Router

an express.Router

Generated using TypeDoc

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional options: Options

Returns Application

Properties

app

cache

events

log

router

Methods

load

Parameters

appFn: ApplicationFunction | ApplicationFunction[]

Returns Application

on

Parameters

event: "check_run" | "check_run.completed" | "check_run.created" | "check_run.requested_action" | "check_run.rerequested"

callback: OnCallback<Webhooks.WebhookPayloadCheckRun>

Returns void

Parameters

event: "check_suite" | "check_suite.completed" | "check_suite.requested" | "check_suite.rerequested"

callback: OnCallback<Webhooks.WebhookPayloadCheckSuite>

Returns void

Parameters

event: "commit_comment" | "commit_comment.created"

callback: OnCallback<Webhooks.WebhookPayloadCommitComment>

Returns void

Parameters

event: "create"

callback: OnCallback<Webhooks.WebhookPayloadCreate>

Returns void

Parameters

event: "delete"

callback: OnCallback<Webhooks.WebhookPayloadDelete>

Returns void

Parameters

event: "deployment"

callback: OnCallback<Webhooks.WebhookPayloadDeployment>

Returns void

Parameters

event: "deployment_status"

callback: OnCallback<Webhooks.WebhookPayloadDeploymentStatus>

Returns void

Parameters

event: "fork"

callback: OnCallback<Webhooks.WebhookPayloadFork>

Returns void

Parameters

event: "github_app_authorization"

callback: OnCallback<Webhooks.WebhookPayloadGithubAppAuthorization>

Returns void

Parameters

event: "gollum"

callback: OnCallback<Webhooks.WebhookPayloadGollum>

Returns void

Parameters

event: "installation" | "installation.created" | "installation.deleted"

callback: OnCallback<Webhooks.WebhookPayloadInstallation>

Returns void

Parameters

event: "installation_repositories" | "installation_repositories.added" | "installation_repositories.removed"

callback: OnCallback<Webhooks.WebhookPayloadInstallationRepositories>

Returns void

Parameters

event: "issue_comment" | "issue_comment.created" | "issue_comment.deleted" | "issue_comment.edited"

callback: OnCallback<Webhooks.WebhookPayloadIssueComment>

Returns void

Parameters

event: "issues" | "issues.assigned" | "issues.closed" | "issues.deleted" | "issues.demilestoned" | "issues.edited" | "issues.labeled" | "issues.milestoned" | "issues.opened" | "issues.reopened" | "issues.transferred" | "issues.unassigned" | "issues.unlabeled"

callback: OnCallback<Webhooks.WebhookPayloadIssues>

Returns void

Parameters

event: "label" | "label.created" | "label.deleted" | "label.edited"