diff --git a/_submodules/probot b/_submodules/probot index 93edf0293d2..228d506f832 160000 --- a/_submodules/probot +++ b/_submodules/probot @@ -1 +1 @@ -Subproject commit 93edf0293d240ca9a487a7a94cfcc1b69438a4d7 +Subproject commit 228d506f8329fcea00474fd77161fafb4a801777 diff --git a/api/13.3.6/classes/context.Context.html b/api/13.3.6/classes/context.Context.html index 0e70c70d1b7..a765995d9d3 100644 --- a/api/13.3.6/classes/context.Context.html +++ b/api/13.3.6/classes/context.Context.html @@ -3,7 +3,7 @@ 
export default app => {
  app.on('push', context => {
    context.log.info('Code was pushed to the repo, what should we do with it?');
  });
};
-

Type Parameters

Constructors

constructor +

Type Parameters

  • E extends WebhookEvents = WebhookEvents

Constructors

constructor

Properties

id log name @@ -14,11 +14,11 @@ issue pullRequest repo -

Constructors

constructor

  • new Context<E>(event, octokit, log): Context<E>

  • Type Parameters

    • E extends
          | "status"
          | "branch_protection_configuration"
          | "branch_protection_rule.disabled"
          | "branch_protection_rule.enabled"
          | "branch_protection_rule"
          | "branch_protection_rule.created"
          | "branch_protection_rule.deleted"
          | "branch_protection_rule.edited"
          | "check_run"
          | "check_run.completed"
          | "check_run.created"
          | "check_run.requested_action"
          | "check_run.rerequested"
          | "check_suite"
          | "check_suite.completed"
          | "check_suite.requested"
          | "check_suite.rerequested"
          | "code_scanning_alert"
          | "code_scanning_alert.appeared_in_branch"
          | "code_scanning_alert.closed_by_user"
          | "code_scanning_alert.created"
          | "code_scanning_alert.fixed"
          | "code_scanning_alert.reopened"
          | "code_scanning_alert.reopened_by_user"
          | "commit_comment"
          | "commit_comment.created"
          | "create"
          | "custom_property"
          | "custom_property.created"
          | "custom_property.deleted"
          | "custom_property_values"
          | "custom_property_values.updated"
          | "delete"
          | "dependabot_alert"
          | "dependabot_alert.created"
          | "dependabot_alert.dismissed"
          | "dependabot_alert.fixed"
          | "dependabot_alert.reintroduced"
          | "dependabot_alert.reopened"
          | "deploy_key"
          | "deploy_key.created"
          | "deploy_key.deleted"
          | "deployment"
          | "deployment.created"
          | "deployment_protection_rule"
          | "deployment_protection_rule.requested"
          | "deployment_review"
          | "deployment_review.approved"
          | "deployment_review.rejected"
          | "deployment_review.requested"
          | "deployment_status"
          | "deployment_status.created"
          | "discussion"
          | "discussion.answered"
          | "discussion.category_changed"
          | "discussion.created"
          | "discussion.deleted"
          | "discussion.edited"
          | "discussion.labeled"
          | "discussion.locked"
          | "discussion.pinned"
          | "discussion.transferred"
          | "discussion.unanswered"
          | "discussion.unlabeled"
          | "discussion.unlocked"
          | "discussion.unpinned"
          | "discussion_comment"
          | "discussion_comment.created"
          | "discussion_comment.deleted"
          | "discussion_comment.edited"
          | "fork"
          | "github_app_authorization"
          | "github_app_authorization.revoked"
          | "gollum"
          | "installation"
          | "installation.created"
          | "installation.deleted"
          | "installation.new_permissions_accepted"
          | "installation.suspend"
          | "installation.unsuspend"
          | "installation_repositories"
          | "installation_repositories.added"
          | "installation_repositories.removed"
          | "installation_target"
          | "installation_target.renamed"
          | "issue_comment"
          | "issue_comment.created"
          | "issue_comment.deleted"
          | "issue_comment.edited"
          | "issues"
          | "issues.assigned"
          | "issues.closed"
          | "issues.deleted"
          | "issues.demilestoned"
          | "issues.edited"
          | "issues.labeled"
          | "issues.locked"
          | "issues.milestoned"
          | "issues.opened"
          | "issues.pinned"
          | "issues.reopened"
          | "issues.transferred"
          | "issues.unassigned"
          | "issues.unlabeled"
          | "issues.unlocked"
          | "issues.unpinned"
          | "label"
          | "label.created"
          | "label.deleted"
          | "label.edited"
          | "marketplace_purchase"
          | "marketplace_purchase.cancelled"
          | "marketplace_purchase.changed"
          | "marketplace_purchase.pending_change"
          | "marketplace_purchase.pending_change_cancelled"
          | "marketplace_purchase.purchased"
          | "member"
          | "member.added"
          | "member.edited"
          | "member.removed"
          | "membership"
          | "membership.added"
          | "membership.removed"
          | "merge_group"
          | "merge_group.checks_requested"
          | "meta"
          | "meta.deleted"
          | "milestone"
          | "milestone.closed"
          | "milestone.created"
          | "milestone.deleted"
          | "milestone.edited"
          | "milestone.opened"
          | "org_block"
          | "org_block.blocked"
          | "org_block.unblocked"
          | "organization"
          | "organization.deleted"
          | "organization.member_added"
          | "organization.member_invited"
          | "organization.member_removed"
          | "organization.renamed"
          | "package"
          | "package.published"
          | "package.updated"
          | "page_build"
          | "ping"
          | "project"
          | "project.closed"
          | "project.created"
          | "project.deleted"
          | "project.edited"
          | "project.reopened"
          | "project_card"
          | "project_card.converted"
          | "project_card.created"
          | "project_card.deleted"
          | "project_card.edited"
          | "project_card.moved"
          | "project_column"
          | "project_column.created"
          | "project_column.deleted"
          | "project_column.edited"
          | "project_column.moved"
          | "projects_v2_item"
          | "projects_v2_item.archived"
          | "projects_v2_item.converted"
          | "projects_v2_item.created"
          | "projects_v2_item.deleted"
          | "projects_v2_item.edited"
          | "projects_v2_item.reordered"
          | "projects_v2_item.restored"
          | "public"
          | "pull_request"
          | "pull_request.assigned"
          | "pull_request.auto_merge_disabled"
          | "pull_request.auto_merge_enabled"
          | "pull_request.closed"
          | "pull_request.converted_to_draft"
          | "pull_request.demilestoned"
          | "pull_request.dequeued"
          | "pull_request.edited"
          | "pull_request.enqueued"
          | "pull_request.labeled"
          | "pull_request.locked"
          | "pull_request.milestoned"
          | "pull_request.opened"
          | "pull_request.ready_for_review"
          | "pull_request.reopened"
          | "pull_request.review_request_removed"
          | "pull_request.review_requested"
          | "pull_request.synchronize"
          | "pull_request.unassigned"
          | "pull_request.unlabeled"
          | "pull_request.unlocked"
          | "pull_request_review"
          | "pull_request_review.dismissed"
          | "pull_request_review.edited"
          | "pull_request_review.submitted"
          | "pull_request_review_comment"
          | "pull_request_review_comment.created"
          | "pull_request_review_comment.deleted"
          | "pull_request_review_comment.edited"
          | "pull_request_review_thread"
          | "pull_request_review_thread.resolved"
          | "pull_request_review_thread.unresolved"
          | "push"
          | "registry_package"
          | "registry_package.published"
          | "registry_package.updated"
          | "release"
          | "release.created"
          | "release.deleted"
          | "release.edited"
          | "release.prereleased"
          | "release.published"
          | "release.released"
          | "release.unpublished"
          | "repository"
          | "repository.archived"
          | "repository.created"
          | "repository.deleted"
          | "repository.edited"
          | "repository.privatized"
          | "repository.publicized"
          | "repository.renamed"
          | "repository.transferred"
          | "repository.unarchived"
          | "repository_dispatch"
          | "repository_import"
          | "repository_vulnerability_alert"
          | "repository_vulnerability_alert.create"
          | "repository_vulnerability_alert.dismiss"
          | "repository_vulnerability_alert.reopen"
          | "repository_vulnerability_alert.resolve"
          | "secret_scanning_alert"
          | "secret_scanning_alert.created"
          | "secret_scanning_alert.reopened"
          | "secret_scanning_alert.resolved"
          | "secret_scanning_alert.revoked"
          | "secret_scanning_alert_location"
          | "secret_scanning_alert_location.created"
          | "security_advisory"
          | "security_advisory.performed"
          | "security_advisory.published"
          | "security_advisory.updated"
          | "security_advisory.withdrawn"
          | "sponsorship"
          | "sponsorship.cancelled"
          | "sponsorship.created"
          | "sponsorship.edited"
          | "sponsorship.pending_cancellation"
          | "sponsorship.pending_tier_change"
          | "sponsorship.tier_changed"
          | "star"
          | "star.created"
          | "star.deleted"
          | "team"
          | "team.added_to_repository"
          | "team.created"
          | "team.deleted"
          | "team.edited"
          | "team.removed_from_repository"
          | "team_add"
          | "watch"
          | "watch.started"
          | "workflow_dispatch"
          | "workflow_job"
          | "workflow_job.completed"
          | "workflow_job.in_progress"
          | "workflow_job.queued"
          | "workflow_job.waiting"
          | "workflow_run"
          | "workflow_run.completed"
          | "workflow_run.in_progress"
          | "workflow_run.requested" =
          | "status"
          | "branch_protection_configuration"
          | "branch_protection_rule.disabled"
          | "branch_protection_rule.enabled"
          | "branch_protection_rule"
          | "branch_protection_rule.created"
          | "branch_protection_rule.deleted"
          | "branch_protection_rule.edited"
          | "check_run"
          | "check_run.completed"
          | "check_run.created"
          | "check_run.requested_action"
          | "check_run.rerequested"
          | "check_suite"
          | "check_suite.completed"
          | "check_suite.requested"
          | "check_suite.rerequested"
          | "code_scanning_alert"
          | "code_scanning_alert.appeared_in_branch"
          | "code_scanning_alert.closed_by_user"
          | "code_scanning_alert.created"
          | "code_scanning_alert.fixed"
          | "code_scanning_alert.reopened"
          | "code_scanning_alert.reopened_by_user"
          | "commit_comment"
          | "commit_comment.created"
          | "create"
          | "custom_property"
          | "custom_property.created"
          | "custom_property.deleted"
          | "custom_property_values"
          | "custom_property_values.updated"
          | "delete"
          | "dependabot_alert"
          | "dependabot_alert.created"
          | "dependabot_alert.dismissed"
          | "dependabot_alert.fixed"
          | "dependabot_alert.reintroduced"
          | "dependabot_alert.reopened"
          | "deploy_key"
          | "deploy_key.created"
          | "deploy_key.deleted"
          | "deployment"
          | "deployment.created"
          | "deployment_protection_rule"
          | "deployment_protection_rule.requested"
          | "deployment_review"
          | "deployment_review.approved"
          | "deployment_review.rejected"
          | "deployment_review.requested"
          | "deployment_status"
          | "deployment_status.created"
          | "discussion"
          | "discussion.answered"
          | "discussion.category_changed"
          | "discussion.created"
          | "discussion.deleted"
          | "discussion.edited"
          | "discussion.labeled"
          | "discussion.locked"
          | "discussion.pinned"
          | "discussion.transferred"
          | "discussion.unanswered"
          | "discussion.unlabeled"
          | "discussion.unlocked"
          | "discussion.unpinned"
          | "discussion_comment"
          | "discussion_comment.created"
          | "discussion_comment.deleted"
          | "discussion_comment.edited"
          | "fork"
          | "github_app_authorization"
          | "github_app_authorization.revoked"
          | "gollum"
          | "installation"
          | "installation.created"
          | "installation.deleted"
          | "installation.new_permissions_accepted"
          | "installation.suspend"
          | "installation.unsuspend"
          | "installation_repositories"
          | "installation_repositories.added"
          | "installation_repositories.removed"
          | "installation_target"
          | "installation_target.renamed"
          | "issue_comment"
          | "issue_comment.created"
          | "issue_comment.deleted"
          | "issue_comment.edited"
          | "issues"
          | "issues.assigned"
          | "issues.closed"
          | "issues.deleted"
          | "issues.demilestoned"
          | "issues.edited"
          | "issues.labeled"
          | "issues.locked"
          | "issues.milestoned"
          | "issues.opened"
          | "issues.pinned"
          | "issues.reopened"
          | "issues.transferred"
          | "issues.unassigned"
          | "issues.unlabeled"
          | "issues.unlocked"
          | "issues.unpinned"
          | "label"
          | "label.created"
          | "label.deleted"
          | "label.edited"
          | "marketplace_purchase"
          | "marketplace_purchase.cancelled"
          | "marketplace_purchase.changed"
          | "marketplace_purchase.pending_change"
          | "marketplace_purchase.pending_change_cancelled"
          | "marketplace_purchase.purchased"
          | "member"
          | "member.added"
          | "member.edited"
          | "member.removed"
          | "membership"
          | "membership.added"
          | "membership.removed"
          | "merge_group"
          | "merge_group.checks_requested"
          | "meta"
          | "meta.deleted"
          | "milestone"
          | "milestone.closed"
          | "milestone.created"
          | "milestone.deleted"
          | "milestone.edited"
          | "milestone.opened"
          | "org_block"
          | "org_block.blocked"
          | "org_block.unblocked"
          | "organization"
          | "organization.deleted"
          | "organization.member_added"
          | "organization.member_invited"
          | "organization.member_removed"
          | "organization.renamed"
          | "package"
          | "package.published"
          | "package.updated"
          | "page_build"
          | "ping"
          | "project"
          | "project.closed"
          | "project.created"
          | "project.deleted"
          | "project.edited"
          | "project.reopened"
          | "project_card"
          | "project_card.converted"
          | "project_card.created"
          | "project_card.deleted"
          | "project_card.edited"
          | "project_card.moved"
          | "project_column"
          | "project_column.created"
          | "project_column.deleted"
          | "project_column.edited"
          | "project_column.moved"
          | "projects_v2_item"
          | "projects_v2_item.archived"
          | "projects_v2_item.converted"
          | "projects_v2_item.created"
          | "projects_v2_item.deleted"
          | "projects_v2_item.edited"
          | "projects_v2_item.reordered"
          | "projects_v2_item.restored"
          | "public"
          | "pull_request"
          | "pull_request.assigned"
          | "pull_request.auto_merge_disabled"
          | "pull_request.auto_merge_enabled"
          | "pull_request.closed"
          | "pull_request.converted_to_draft"
          | "pull_request.demilestoned"
          | "pull_request.dequeued"
          | "pull_request.edited"
          | "pull_request.enqueued"
          | "pull_request.labeled"
          | "pull_request.locked"
          | "pull_request.milestoned"
          | "pull_request.opened"
          | "pull_request.ready_for_review"
          | "pull_request.reopened"
          | "pull_request.review_request_removed"
          | "pull_request.review_requested"
          | "pull_request.synchronize"
          | "pull_request.unassigned"
          | "pull_request.unlabeled"
          | "pull_request.unlocked"
          | "pull_request_review"
          | "pull_request_review.dismissed"
          | "pull_request_review.edited"
          | "pull_request_review.submitted"
          | "pull_request_review_comment"
          | "pull_request_review_comment.created"
          | "pull_request_review_comment.deleted"
          | "pull_request_review_comment.edited"
          | "pull_request_review_thread"
          | "pull_request_review_thread.resolved"
          | "pull_request_review_thread.unresolved"
          | "push"
          | "registry_package"
          | "registry_package.published"
          | "registry_package.updated"
          | "release"
          | "release.created"
          | "release.deleted"
          | "release.edited"
          | "release.prereleased"
          | "release.published"
          | "release.released"
          | "release.unpublished"
          | "repository"
          | "repository.archived"
          | "repository.created"
          | "repository.deleted"
          | "repository.edited"
          | "repository.privatized"
          | "repository.publicized"
          | "repository.renamed"
          | "repository.transferred"
          | "repository.unarchived"
          | "repository_dispatch"
          | "repository_import"
          | "repository_vulnerability_alert"
          | "repository_vulnerability_alert.create"
          | "repository_vulnerability_alert.dismiss"
          | "repository_vulnerability_alert.reopen"
          | "repository_vulnerability_alert.resolve"
          | "secret_scanning_alert"
          | "secret_scanning_alert.created"
          | "secret_scanning_alert.reopened"
          | "secret_scanning_alert.resolved"
          | "secret_scanning_alert.revoked"
          | "secret_scanning_alert_location"
          | "secret_scanning_alert_location.created"
          | "security_advisory"
          | "security_advisory.performed"
          | "security_advisory.published"
          | "security_advisory.updated"
          | "security_advisory.withdrawn"
          | "sponsorship"
          | "sponsorship.cancelled"
          | "sponsorship.created"
          | "sponsorship.edited"
          | "sponsorship.pending_cancellation"
          | "sponsorship.pending_tier_change"
          | "sponsorship.tier_changed"
          | "star"
          | "star.created"
          | "star.deleted"
          | "team"
          | "team.added_to_repository"
          | "team.created"
          | "team.deleted"
          | "team.edited"
          | "team.removed_from_repository"
          | "team_add"
          | "watch"
          | "watch.started"
          | "workflow_dispatch"
          | "workflow_job"
          | "workflow_job.completed"
          | "workflow_job.in_progress"
          | "workflow_job.queued"
          | "workflow_job.waiting"
          | "workflow_run"
          | "workflow_run.completed"
          | "workflow_run.in_progress"
          | "workflow_run.requested"

    Parameters

    • event: EmitterWebhookEvent<E>
    • octokit: Octokit & {} & {} & RestEndpointMethods & Api & API
    • log: Logger

    Returns Context<E>

Properties

id

id: string

log

log: Logger

A pino instance

-

name

name:
    | "status"
    | "branch_protection_configuration"
    | "branch_protection_rule.disabled"
    | "branch_protection_rule.enabled"
    | "branch_protection_rule"
    | "branch_protection_rule.created"
    | "branch_protection_rule.deleted"
    | "branch_protection_rule.edited"
    | "check_run"
    | "check_run.completed"
    | "check_run.created"
    | "check_run.requested_action"
    | "check_run.rerequested"
    | "check_suite"
    | "check_suite.completed"
    | "check_suite.requested"
    | "check_suite.rerequested"
    | "code_scanning_alert"
    | "code_scanning_alert.appeared_in_branch"
    | "code_scanning_alert.closed_by_user"
    | "code_scanning_alert.created"
    | "code_scanning_alert.fixed"
    | "code_scanning_alert.reopened"
    | "code_scanning_alert.reopened_by_user"
    | "commit_comment"
    | "commit_comment.created"
    | "create"
    | "custom_property"
    | "custom_property.created"
    | "custom_property.deleted"
    | "custom_property_values"
    | "custom_property_values.updated"
    | "delete"
    | "dependabot_alert"
    | "dependabot_alert.created"
    | "dependabot_alert.dismissed"
    | "dependabot_alert.fixed"
    | "dependabot_alert.reintroduced"
    | "dependabot_alert.reopened"
    | "deploy_key"
    | "deploy_key.created"
    | "deploy_key.deleted"
    | "deployment"
    | "deployment.created"
    | "deployment_protection_rule"
    | "deployment_protection_rule.requested"
    | "deployment_review"
    | "deployment_review.approved"
    | "deployment_review.rejected"
    | "deployment_review.requested"
    | "deployment_status"
    | "deployment_status.created"
    | "discussion"
    | "discussion.answered"
    | "discussion.category_changed"
    | "discussion.created"
    | "discussion.deleted"
    | "discussion.edited"
    | "discussion.labeled"
    | "discussion.locked"
    | "discussion.pinned"
    | "discussion.transferred"
    | "discussion.unanswered"
    | "discussion.unlabeled"
    | "discussion.unlocked"
    | "discussion.unpinned"
    | "discussion_comment"
    | "discussion_comment.created"
    | "discussion_comment.deleted"
    | "discussion_comment.edited"
    | "fork"
    | "github_app_authorization"
    | "github_app_authorization.revoked"
    | "gollum"
    | "installation"
    | "installation.created"
    | "installation.deleted"
    | "installation.new_permissions_accepted"
    | "installation.suspend"
    | "installation.unsuspend"
    | "installation_repositories"
    | "installation_repositories.added"
    | "installation_repositories.removed"
    | "installation_target"
    | "installation_target.renamed"
    | "issue_comment"
    | "issue_comment.created"
    | "issue_comment.deleted"
    | "issue_comment.edited"
    | "issues"
    | "issues.assigned"
    | "issues.closed"
    | "issues.deleted"
    | "issues.demilestoned"
    | "issues.edited"
    | "issues.labeled"
    | "issues.locked"
    | "issues.milestoned"
    | "issues.opened"
    | "issues.pinned"
    | "issues.reopened"
    | "issues.transferred"
    | "issues.unassigned"
    | "issues.unlabeled"
    | "issues.unlocked"
    | "issues.unpinned"
    | "label"
    | "label.created"
    | "label.deleted"
    | "label.edited"
    | "marketplace_purchase"
    | "marketplace_purchase.cancelled"
    | "marketplace_purchase.changed"
    | "marketplace_purchase.pending_change"
    | "marketplace_purchase.pending_change_cancelled"
    | "marketplace_purchase.purchased"
    | "member"
    | "member.added"
    | "member.edited"
    | "member.removed"
    | "membership"
    | "membership.added"
    | "membership.removed"
    | "merge_group"
    | "merge_group.checks_requested"
    | "meta"
    | "meta.deleted"
    | "milestone"
    | "milestone.closed"
    | "milestone.created"
    | "milestone.deleted"
    | "milestone.edited"
    | "milestone.opened"
    | "org_block"
    | "org_block.blocked"
    | "org_block.unblocked"
    | "organization"
    | "organization.deleted"
    | "organization.member_added"
    | "organization.member_invited"
    | "organization.member_removed"
    | "organization.renamed"
    | "package"
    | "package.published"
    | "package.updated"
    | "page_build"
    | "ping"
    | "project"
    | "project.closed"
    | "project.created"
    | "project.deleted"
    | "project.edited"
    | "project.reopened"
    | "project_card"
    | "project_card.converted"
    | "project_card.created"
    | "project_card.deleted"
    | "project_card.edited"
    | "project_card.moved"
    | "project_column"
    | "project_column.created"
    | "project_column.deleted"
    | "project_column.edited"
    | "project_column.moved"
    | "projects_v2_item"
    | "projects_v2_item.archived"
    | "projects_v2_item.converted"
    | "projects_v2_item.created"
    | "projects_v2_item.deleted"
    | "projects_v2_item.edited"
    | "projects_v2_item.reordered"
    | "projects_v2_item.restored"
    | "public"
    | "pull_request"
    | "pull_request.assigned"
    | "pull_request.auto_merge_disabled"
    | "pull_request.auto_merge_enabled"
    | "pull_request.closed"
    | "pull_request.converted_to_draft"
    | "pull_request.demilestoned"
    | "pull_request.dequeued"
    | "pull_request.edited"
    | "pull_request.enqueued"
    | "pull_request.labeled"
    | "pull_request.locked"
    | "pull_request.milestoned"
    | "pull_request.opened"
    | "pull_request.ready_for_review"
    | "pull_request.reopened"
    | "pull_request.review_request_removed"
    | "pull_request.review_requested"
    | "pull_request.synchronize"
    | "pull_request.unassigned"
    | "pull_request.unlabeled"
    | "pull_request.unlocked"
    | "pull_request_review"
    | "pull_request_review.dismissed"
    | "pull_request_review.edited"
    | "pull_request_review.submitted"
    | "pull_request_review_comment"
    | "pull_request_review_comment.created"
    | "pull_request_review_comment.deleted"
    | "pull_request_review_comment.edited"
    | "pull_request_review_thread"
    | "pull_request_review_thread.resolved"
    | "pull_request_review_thread.unresolved"
    | "push"
    | "registry_package"
    | "registry_package.published"
    | "registry_package.updated"
    | "release"
    | "release.created"
    | "release.deleted"
    | "release.edited"
    | "release.prereleased"
    | "release.published"
    | "release.released"
    | "release.unpublished"
    | "repository"
    | "repository.archived"
    | "repository.created"
    | "repository.deleted"
    | "repository.edited"
    | "repository.privatized"
    | "repository.publicized"
    | "repository.renamed"
    | "repository.transferred"
    | "repository.unarchived"
    | "repository_dispatch"
    | "repository_import"
    | "repository_vulnerability_alert"
    | "repository_vulnerability_alert.create"
    | "repository_vulnerability_alert.dismiss"
    | "repository_vulnerability_alert.reopen"
    | "repository_vulnerability_alert.resolve"
    | "secret_scanning_alert"
    | "secret_scanning_alert.created"
    | "secret_scanning_alert.reopened"
    | "secret_scanning_alert.resolved"
    | "secret_scanning_alert.revoked"
    | "secret_scanning_alert_location"
    | "secret_scanning_alert_location.created"
    | "security_advisory"
    | "security_advisory.performed"
    | "security_advisory.published"
    | "security_advisory.updated"
    | "security_advisory.withdrawn"
    | "sponsorship"
    | "sponsorship.cancelled"
    | "sponsorship.created"
    | "sponsorship.edited"
    | "sponsorship.pending_cancellation"
    | "sponsorship.pending_tier_change"
    | "sponsorship.tier_changed"
    | "star"
    | "star.created"
    | "star.deleted"
    | "team"
    | "team.added_to_repository"
    | "team.created"
    | "team.deleted"
    | "team.edited"
    | "team.removed_from_repository"
    | "team_add"
    | "watch"
    | "watch.started"
    | "workflow_dispatch"
    | "workflow_job"
    | "workflow_job.completed"
    | "workflow_job.in_progress"
    | "workflow_job.queued"
    | "workflow_job.waiting"
    | "workflow_run"
    | "workflow_run.completed"
    | "workflow_run.in_progress"
    | "workflow_run.requested"

octokit

octokit: Octokit & {} & {} & RestEndpointMethods & Api & API

An Octokit instance

-

payload

payload: EmitterWebhookEvent<E>["payload"]

The webhook event payload

-

Accessors

isBot

  • get isBot(): boolean

  • Returns a boolean if the actor on the event was a bot.

    -

    Returns boolean

Methods

config

  • config<T>(fileName, defaultConfig?, deepMergeOptions?): Promise<null | T>

  • Reads the app configuration from the given YAML file in the .github +

Constructors

constructor

  • new Context<E>(event, octokit, log): Context<E>

  • Type Parameters

    • E extends
          | "status"
          | "branch_protection_configuration"
          | "branch_protection_rule.disabled"
          | "branch_protection_rule.enabled"
          | "branch_protection_rule"
          | "branch_protection_rule.created"
          | "branch_protection_rule.deleted"
          | "branch_protection_rule.edited"
          | "check_run"
          | "check_run.completed"
          | "check_run.created"
          | "check_run.requested_action"
          | "check_run.rerequested"
          | "check_suite"
          | "check_suite.completed"
          | "check_suite.requested"
          | "check_suite.rerequested"
          | "code_scanning_alert"
          | "code_scanning_alert.appeared_in_branch"
          | "code_scanning_alert.closed_by_user"
          | "code_scanning_alert.created"
          | "code_scanning_alert.fixed"
          | "code_scanning_alert.reopened"
          | "code_scanning_alert.reopened_by_user"
          | "commit_comment"
          | "commit_comment.created"
          | "create"
          | "custom_property"
          | "custom_property.created"
          | "custom_property.deleted"
          | "custom_property_values"
          | "custom_property_values.updated"
          | "delete"
          | "dependabot_alert"
          | "dependabot_alert.created"
          | "dependabot_alert.dismissed"
          | "dependabot_alert.fixed"
          | "dependabot_alert.reintroduced"
          | "dependabot_alert.reopened"
          | "deploy_key"
          | "deploy_key.created"
          | "deploy_key.deleted"
          | "deployment"
          | "deployment.created"
          | "deployment_protection_rule"
          | "deployment_protection_rule.requested"
          | "deployment_review"
          | "deployment_review.approved"
          | "deployment_review.rejected"
          | "deployment_review.requested"
          | "deployment_status"
          | "deployment_status.created"
          | "discussion"
          | "discussion.answered"
          | "discussion.category_changed"
          | "discussion.created"
          | "discussion.deleted"
          | "discussion.edited"
          | "discussion.labeled"
          | "discussion.locked"
          | "discussion.pinned"
          | "discussion.transferred"
          | "discussion.unanswered"
          | "discussion.unlabeled"
          | "discussion.unlocked"
          | "discussion.unpinned"
          | "discussion_comment"
          | "discussion_comment.created"
          | "discussion_comment.deleted"
          | "discussion_comment.edited"
          | "fork"
          | "github_app_authorization"
          | "github_app_authorization.revoked"
          | "gollum"
          | "installation"
          | "installation.created"
          | "installation.deleted"
          | "installation.new_permissions_accepted"
          | "installation.suspend"
          | "installation.unsuspend"
          | "installation_repositories"
          | "installation_repositories.added"
          | "installation_repositories.removed"
          | "installation_target"
          | "installation_target.renamed"
          | "issue_comment"
          | "issue_comment.created"
          | "issue_comment.deleted"
          | "issue_comment.edited"
          | "issues"
          | "issues.assigned"
          | "issues.closed"
          | "issues.deleted"
          | "issues.demilestoned"
          | "issues.edited"
          | "issues.labeled"
          | "issues.locked"
          | "issues.milestoned"
          | "issues.opened"
          | "issues.pinned"
          | "issues.reopened"
          | "issues.transferred"
          | "issues.unassigned"
          | "issues.unlabeled"
          | "issues.unlocked"
          | "issues.unpinned"
          | "label"
          | "label.created"
          | "label.deleted"
          | "label.edited"
          | "marketplace_purchase"
          | "marketplace_purchase.cancelled"
          | "marketplace_purchase.changed"
          | "marketplace_purchase.pending_change"
          | "marketplace_purchase.pending_change_cancelled"
          | "marketplace_purchase.purchased"
          | "member"
          | "member.added"
          | "member.edited"
          | "member.removed"
          | "membership"
          | "membership.added"
          | "membership.removed"
          | "merge_group"
          | "merge_group.checks_requested"
          | "meta"
          | "meta.deleted"
          | "milestone"
          | "milestone.closed"
          | "milestone.created"
          | "milestone.deleted"
          | "milestone.edited"
          | "milestone.opened"
          | "org_block"
          | "org_block.blocked"
          | "org_block.unblocked"
          | "organization"
          | "organization.deleted"
          | "organization.member_added"
          | "organization.member_invited"
          | "organization.member_removed"
          | "organization.renamed"
          | "package"
          | "package.published"
          | "package.updated"
          | "page_build"
          | "ping"
          | "project"
          | "project.closed"
          | "project.created"
          | "project.deleted"
          | "project.edited"
          | "project.reopened"
          | "project_card"
          | "project_card.converted"
          | "project_card.created"
          | "project_card.deleted"
          | "project_card.edited"
          | "project_card.moved"
          | "project_column"
          | "project_column.created"
          | "project_column.deleted"
          | "project_column.edited"
          | "project_column.moved"
          | "projects_v2_item"
          | "projects_v2_item.archived"
          | "projects_v2_item.converted"
          | "projects_v2_item.created"
          | "projects_v2_item.deleted"
          | "projects_v2_item.edited"
          | "projects_v2_item.reordered"
          | "projects_v2_item.restored"
          | "public"
          | "pull_request"
          | "pull_request.assigned"
          | "pull_request.auto_merge_disabled"
          | "pull_request.auto_merge_enabled"
          | "pull_request.closed"
          | "pull_request.converted_to_draft"
          | "pull_request.demilestoned"
          | "pull_request.dequeued"
          | "pull_request.edited"
          | "pull_request.enqueued"
          | "pull_request.labeled"
          | "pull_request.locked"
          | "pull_request.milestoned"
          | "pull_request.opened"
          | "pull_request.ready_for_review"
          | "pull_request.reopened"
          | "pull_request.review_request_removed"
          | "pull_request.review_requested"
          | "pull_request.synchronize"
          | "pull_request.unassigned"
          | "pull_request.unlabeled"
          | "pull_request.unlocked"
          | "pull_request_review"
          | "pull_request_review.dismissed"
          | "pull_request_review.edited"
          | "pull_request_review.submitted"
          | "pull_request_review_comment"
          | "pull_request_review_comment.created"
          | "pull_request_review_comment.deleted"
          | "pull_request_review_comment.edited"
          | "pull_request_review_thread"
          | "pull_request_review_thread.resolved"
          | "pull_request_review_thread.unresolved"
          | "push"
          | "registry_package"
          | "registry_package.published"
          | "registry_package.updated"
          | "release"
          | "release.created"
          | "release.deleted"
          | "release.edited"
          | "release.prereleased"
          | "release.published"
          | "release.released"
          | "release.unpublished"
          | "repository"
          | "repository.archived"
          | "repository.created"
          | "repository.deleted"
          | "repository.edited"
          | "repository.privatized"
          | "repository.publicized"
          | "repository.renamed"
          | "repository.transferred"
          | "repository.unarchived"
          | "repository_dispatch"
          | "repository_import"
          | "repository_vulnerability_alert"
          | "repository_vulnerability_alert.create"
          | "repository_vulnerability_alert.dismiss"
          | "repository_vulnerability_alert.reopen"
          | "repository_vulnerability_alert.resolve"
          | "secret_scanning_alert"
          | "secret_scanning_alert.created"
          | "secret_scanning_alert.reopened"
          | "secret_scanning_alert.resolved"
          | "secret_scanning_alert.revoked"
          | "secret_scanning_alert_location"
          | "secret_scanning_alert_location.created"
          | "security_advisory"
          | "security_advisory.performed"
          | "security_advisory.published"
          | "security_advisory.updated"
          | "security_advisory.withdrawn"
          | "sponsorship"
          | "sponsorship.cancelled"
          | "sponsorship.created"
          | "sponsorship.edited"
          | "sponsorship.pending_cancellation"
          | "sponsorship.pending_tier_change"
          | "sponsorship.tier_changed"
          | "star"
          | "star.created"
          | "star.deleted"
          | "team"
          | "team.added_to_repository"
          | "team.created"
          | "team.deleted"
          | "team.edited"
          | "team.removed_from_repository"
          | "team_add"
          | "watch"
          | "watch.started"
          | "workflow_dispatch"
          | "workflow_job"
          | "workflow_job.completed"
          | "workflow_job.in_progress"
          | "workflow_job.queued"
          | "workflow_job.waiting"
          | "workflow_run"
          | "workflow_run.completed"
          | "workflow_run.in_progress"
          | "workflow_run.requested" =
          | "status"
          | "branch_protection_configuration"
          | "branch_protection_rule.disabled"
          | "branch_protection_rule.enabled"
          | "branch_protection_rule"
          | "branch_protection_rule.created"
          | "branch_protection_rule.deleted"
          | "branch_protection_rule.edited"
          | "check_run"
          | "check_run.completed"
          | "check_run.created"
          | "check_run.requested_action"
          | "check_run.rerequested"
          | "check_suite"
          | "check_suite.completed"
          | "check_suite.requested"
          | "check_suite.rerequested"
          | "code_scanning_alert"
          | "code_scanning_alert.appeared_in_branch"
          | "code_scanning_alert.closed_by_user"
          | "code_scanning_alert.created"
          | "code_scanning_alert.fixed"
          | "code_scanning_alert.reopened"
          | "code_scanning_alert.reopened_by_user"
          | "commit_comment"
          | "commit_comment.created"
          | "create"
          | "custom_property"
          | "custom_property.created"
          | "custom_property.deleted"
          | "custom_property_values"
          | "custom_property_values.updated"
          | "delete"
          | "dependabot_alert"
          | "dependabot_alert.created"
          | "dependabot_alert.dismissed"
          | "dependabot_alert.fixed"
          | "dependabot_alert.reintroduced"
          | "dependabot_alert.reopened"
          | "deploy_key"
          | "deploy_key.created"
          | "deploy_key.deleted"
          | "deployment"
          | "deployment.created"
          | "deployment_protection_rule"
          | "deployment_protection_rule.requested"
          | "deployment_review"
          | "deployment_review.approved"
          | "deployment_review.rejected"
          | "deployment_review.requested"
          | "deployment_status"
          | "deployment_status.created"
          | "discussion"
          | "discussion.answered"
          | "discussion.category_changed"
          | "discussion.created"
          | "discussion.deleted"
          | "discussion.edited"
          | "discussion.labeled"
          | "discussion.locked"
          | "discussion.pinned"
          | "discussion.transferred"
          | "discussion.unanswered"
          | "discussion.unlabeled"
          | "discussion.unlocked"
          | "discussion.unpinned"
          | "discussion_comment"
          | "discussion_comment.created"
          | "discussion_comment.deleted"
          | "discussion_comment.edited"
          | "fork"
          | "github_app_authorization"
          | "github_app_authorization.revoked"
          | "gollum"
          | "installation"
          | "installation.created"
          | "installation.deleted"
          | "installation.new_permissions_accepted"
          | "installation.suspend"
          | "installation.unsuspend"
          | "installation_repositories"
          | "installation_repositories.added"
          | "installation_repositories.removed"
          | "installation_target"
          | "installation_target.renamed"
          | "issue_comment"
          | "issue_comment.created"
          | "issue_comment.deleted"
          | "issue_comment.edited"
          | "issues"
          | "issues.assigned"
          | "issues.closed"
          | "issues.deleted"
          | "issues.demilestoned"
          | "issues.edited"
          | "issues.labeled"
          | "issues.locked"
          | "issues.milestoned"
          | "issues.opened"
          | "issues.pinned"
          | "issues.reopened"
          | "issues.transferred"
          | "issues.unassigned"
          | "issues.unlabeled"
          | "issues.unlocked"
          | "issues.unpinned"
          | "label"
          | "label.created"
          | "label.deleted"
          | "label.edited"
          | "marketplace_purchase"
          | "marketplace_purchase.cancelled"
          | "marketplace_purchase.changed"
          | "marketplace_purchase.pending_change"
          | "marketplace_purchase.pending_change_cancelled"
          | "marketplace_purchase.purchased"
          | "member"
          | "member.added"
          | "member.edited"
          | "member.removed"
          | "membership"
          | "membership.added"
          | "membership.removed"
          | "merge_group"
          | "merge_group.checks_requested"
          | "meta"
          | "meta.deleted"
          | "milestone"
          | "milestone.closed"
          | "milestone.created"
          | "milestone.deleted"
          | "milestone.edited"
          | "milestone.opened"
          | "org_block"
          | "org_block.blocked"
          | "org_block.unblocked"
          | "organization"
          | "organization.deleted"
          | "organization.member_added"
          | "organization.member_invited"
          | "organization.member_removed"
          | "organization.renamed"
          | "package"
          | "package.published"
          | "package.updated"
          | "page_build"
          | "ping"
          | "project"
          | "project.closed"
          | "project.created"
          | "project.deleted"
          | "project.edited"
          | "project.reopened"
          | "project_card"
          | "project_card.converted"
          | "project_card.created"
          | "project_card.deleted"
          | "project_card.edited"
          | "project_card.moved"
          | "project_column"
          | "project_column.created"
          | "project_column.deleted"
          | "project_column.edited"
          | "project_column.moved"
          | "projects_v2_item"
          | "projects_v2_item.archived"
          | "projects_v2_item.converted"
          | "projects_v2_item.created"
          | "projects_v2_item.deleted"
          | "projects_v2_item.edited"
          | "projects_v2_item.reordered"
          | "projects_v2_item.restored"
          | "public"
          | "pull_request"
          | "pull_request.assigned"
          | "pull_request.auto_merge_disabled"
          | "pull_request.auto_merge_enabled"
          | "pull_request.closed"
          | "pull_request.converted_to_draft"
          | "pull_request.demilestoned"
          | "pull_request.dequeued"
          | "pull_request.edited"
          | "pull_request.enqueued"
          | "pull_request.labeled"
          | "pull_request.locked"
          | "pull_request.milestoned"
          | "pull_request.opened"
          | "pull_request.ready_for_review"
          | "pull_request.reopened"
          | "pull_request.review_request_removed"
          | "pull_request.review_requested"
          | "pull_request.synchronize"
          | "pull_request.unassigned"
          | "pull_request.unlabeled"
          | "pull_request.unlocked"
          | "pull_request_review"
          | "pull_request_review.dismissed"
          | "pull_request_review.edited"
          | "pull_request_review.submitted"
          | "pull_request_review_comment"
          | "pull_request_review_comment.created"
          | "pull_request_review_comment.deleted"
          | "pull_request_review_comment.edited"
          | "pull_request_review_thread"
          | "pull_request_review_thread.resolved"
          | "pull_request_review_thread.unresolved"
          | "push"
          | "registry_package"
          | "registry_package.published"
          | "registry_package.updated"
          | "release"
          | "release.created"
          | "release.deleted"
          | "release.edited"
          | "release.prereleased"
          | "release.published"
          | "release.released"
          | "release.unpublished"
          | "repository"
          | "repository.archived"
          | "repository.created"
          | "repository.deleted"
          | "repository.edited"
          | "repository.privatized"
          | "repository.publicized"
          | "repository.renamed"
          | "repository.transferred"
          | "repository.unarchived"
          | "repository_dispatch"
          | "repository_import"
          | "repository_vulnerability_alert"
          | "repository_vulnerability_alert.create"
          | "repository_vulnerability_alert.dismiss"
          | "repository_vulnerability_alert.reopen"
          | "repository_vulnerability_alert.resolve"
          | "secret_scanning_alert"
          | "secret_scanning_alert.created"
          | "secret_scanning_alert.reopened"
          | "secret_scanning_alert.resolved"
          | "secret_scanning_alert.revoked"
          | "secret_scanning_alert_location"
          | "secret_scanning_alert_location.created"
          | "security_advisory"
          | "security_advisory.performed"
          | "security_advisory.published"
          | "security_advisory.updated"
          | "security_advisory.withdrawn"
          | "sponsorship"
          | "sponsorship.cancelled"
          | "sponsorship.created"
          | "sponsorship.edited"
          | "sponsorship.pending_cancellation"
          | "sponsorship.pending_tier_change"
          | "sponsorship.tier_changed"
          | "star"
          | "star.created"
          | "star.deleted"
          | "team"
          | "team.added_to_repository"
          | "team.created"
          | "team.deleted"
          | "team.edited"
          | "team.removed_from_repository"
          | "team_add"
          | "watch"
          | "watch.started"
          | "workflow_dispatch"
          | "workflow_job"
          | "workflow_job.completed"
          | "workflow_job.in_progress"
          | "workflow_job.queued"
          | "workflow_job.waiting"
          | "workflow_run"
          | "workflow_run.completed"
          | "workflow_run.in_progress"
          | "workflow_run.requested"

    Parameters

    • event: EmitterWebhookEvent<E>
    • octokit: Octokit & {} & {} & RestEndpointMethods & Api & API
    • log: Logger

    Returns Context<E>

Properties

id

id: string

log

log: Logger

A pino instance

+

name

name:
    | "status"
    | "branch_protection_configuration"
    | "branch_protection_rule.disabled"
    | "branch_protection_rule.enabled"
    | "branch_protection_rule"
    | "branch_protection_rule.created"
    | "branch_protection_rule.deleted"
    | "branch_protection_rule.edited"
    | "check_run"
    | "check_run.completed"
    | "check_run.created"
    | "check_run.requested_action"
    | "check_run.rerequested"
    | "check_suite"
    | "check_suite.completed"
    | "check_suite.requested"
    | "check_suite.rerequested"
    | "code_scanning_alert"
    | "code_scanning_alert.appeared_in_branch"
    | "code_scanning_alert.closed_by_user"
    | "code_scanning_alert.created"
    | "code_scanning_alert.fixed"
    | "code_scanning_alert.reopened"
    | "code_scanning_alert.reopened_by_user"
    | "commit_comment"
    | "commit_comment.created"
    | "create"
    | "custom_property"
    | "custom_property.created"
    | "custom_property.deleted"
    | "custom_property_values"
    | "custom_property_values.updated"
    | "delete"
    | "dependabot_alert"
    | "dependabot_alert.created"
    | "dependabot_alert.dismissed"
    | "dependabot_alert.fixed"
    | "dependabot_alert.reintroduced"
    | "dependabot_alert.reopened"
    | "deploy_key"
    | "deploy_key.created"
    | "deploy_key.deleted"
    | "deployment"
    | "deployment.created"
    | "deployment_protection_rule"
    | "deployment_protection_rule.requested"
    | "deployment_review"
    | "deployment_review.approved"
    | "deployment_review.rejected"
    | "deployment_review.requested"
    | "deployment_status"
    | "deployment_status.created"
    | "discussion"
    | "discussion.answered"
    | "discussion.category_changed"
    | "discussion.created"
    | "discussion.deleted"
    | "discussion.edited"
    | "discussion.labeled"
    | "discussion.locked"
    | "discussion.pinned"
    | "discussion.transferred"
    | "discussion.unanswered"
    | "discussion.unlabeled"
    | "discussion.unlocked"
    | "discussion.unpinned"
    | "discussion_comment"
    | "discussion_comment.created"
    | "discussion_comment.deleted"
    | "discussion_comment.edited"
    | "fork"
    | "github_app_authorization"
    | "github_app_authorization.revoked"
    | "gollum"
    | "installation"
    | "installation.created"
    | "installation.deleted"
    | "installation.new_permissions_accepted"
    | "installation.suspend"
    | "installation.unsuspend"
    | "installation_repositories"
    | "installation_repositories.added"
    | "installation_repositories.removed"
    | "installation_target"
    | "installation_target.renamed"
    | "issue_comment"
    | "issue_comment.created"
    | "issue_comment.deleted"
    | "issue_comment.edited"
    | "issues"
    | "issues.assigned"
    | "issues.closed"
    | "issues.deleted"
    | "issues.demilestoned"
    | "issues.edited"
    | "issues.labeled"
    | "issues.locked"
    | "issues.milestoned"
    | "issues.opened"
    | "issues.pinned"
    | "issues.reopened"
    | "issues.transferred"
    | "issues.unassigned"
    | "issues.unlabeled"
    | "issues.unlocked"
    | "issues.unpinned"
    | "label"
    | "label.created"
    | "label.deleted"
    | "label.edited"
    | "marketplace_purchase"
    | "marketplace_purchase.cancelled"
    | "marketplace_purchase.changed"
    | "marketplace_purchase.pending_change"
    | "marketplace_purchase.pending_change_cancelled"
    | "marketplace_purchase.purchased"
    | "member"
    | "member.added"
    | "member.edited"
    | "member.removed"
    | "membership"
    | "membership.added"
    | "membership.removed"
    | "merge_group"
    | "merge_group.checks_requested"
    | "meta"
    | "meta.deleted"
    | "milestone"
    | "milestone.closed"
    | "milestone.created"
    | "milestone.deleted"
    | "milestone.edited"
    | "milestone.opened"
    | "org_block"
    | "org_block.blocked"
    | "org_block.unblocked"
    | "organization"
    | "organization.deleted"
    | "organization.member_added"
    | "organization.member_invited"
    | "organization.member_removed"
    | "organization.renamed"
    | "package"
    | "package.published"
    | "package.updated"
    | "page_build"
    | "ping"
    | "project"
    | "project.closed"
    | "project.created"
    | "project.deleted"
    | "project.edited"
    | "project.reopened"
    | "project_card"
    | "project_card.converted"
    | "project_card.created"
    | "project_card.deleted"
    | "project_card.edited"
    | "project_card.moved"
    | "project_column"
    | "project_column.created"
    | "project_column.deleted"
    | "project_column.edited"
    | "project_column.moved"
    | "projects_v2_item"
    | "projects_v2_item.archived"
    | "projects_v2_item.converted"
    | "projects_v2_item.created"
    | "projects_v2_item.deleted"
    | "projects_v2_item.edited"
    | "projects_v2_item.reordered"
    | "projects_v2_item.restored"
    | "public"
    | "pull_request"
    | "pull_request.assigned"
    | "pull_request.auto_merge_disabled"
    | "pull_request.auto_merge_enabled"
    | "pull_request.closed"
    | "pull_request.converted_to_draft"
    | "pull_request.demilestoned"
    | "pull_request.dequeued"
    | "pull_request.edited"
    | "pull_request.enqueued"
    | "pull_request.labeled"
    | "pull_request.locked"
    | "pull_request.milestoned"
    | "pull_request.opened"
    | "pull_request.ready_for_review"
    | "pull_request.reopened"
    | "pull_request.review_request_removed"
    | "pull_request.review_requested"
    | "pull_request.synchronize"
    | "pull_request.unassigned"
    | "pull_request.unlabeled"
    | "pull_request.unlocked"
    | "pull_request_review"
    | "pull_request_review.dismissed"
    | "pull_request_review.edited"
    | "pull_request_review.submitted"
    | "pull_request_review_comment"
    | "pull_request_review_comment.created"
    | "pull_request_review_comment.deleted"
    | "pull_request_review_comment.edited"
    | "pull_request_review_thread"
    | "pull_request_review_thread.resolved"
    | "pull_request_review_thread.unresolved"
    | "push"
    | "registry_package"
    | "registry_package.published"
    | "registry_package.updated"
    | "release"
    | "release.created"
    | "release.deleted"
    | "release.edited"
    | "release.prereleased"
    | "release.published"
    | "release.released"
    | "release.unpublished"
    | "repository"
    | "repository.archived"
    | "repository.created"
    | "repository.deleted"
    | "repository.edited"
    | "repository.privatized"
    | "repository.publicized"
    | "repository.renamed"
    | "repository.transferred"
    | "repository.unarchived"
    | "repository_dispatch"
    | "repository_import"
    | "repository_vulnerability_alert"
    | "repository_vulnerability_alert.create"
    | "repository_vulnerability_alert.dismiss"
    | "repository_vulnerability_alert.reopen"
    | "repository_vulnerability_alert.resolve"
    | "secret_scanning_alert"
    | "secret_scanning_alert.created"
    | "secret_scanning_alert.reopened"
    | "secret_scanning_alert.resolved"
    | "secret_scanning_alert.revoked"
    | "secret_scanning_alert_location"
    | "secret_scanning_alert_location.created"
    | "security_advisory"
    | "security_advisory.performed"
    | "security_advisory.published"
    | "security_advisory.updated"
    | "security_advisory.withdrawn"
    | "sponsorship"
    | "sponsorship.cancelled"
    | "sponsorship.created"
    | "sponsorship.edited"
    | "sponsorship.pending_cancellation"
    | "sponsorship.pending_tier_change"
    | "sponsorship.tier_changed"
    | "star"
    | "star.created"
    | "star.deleted"
    | "team"
    | "team.added_to_repository"
    | "team.created"
    | "team.deleted"
    | "team.edited"
    | "team.removed_from_repository"
    | "team_add"
    | "watch"
    | "watch.started"
    | "workflow_dispatch"
    | "workflow_job"
    | "workflow_job.completed"
    | "workflow_job.in_progress"
    | "workflow_job.queued"
    | "workflow_job.waiting"
    | "workflow_run"
    | "workflow_run.completed"
    | "workflow_run.in_progress"
    | "workflow_run.requested"

octokit

octokit: Octokit & {} & {} & RestEndpointMethods & Api & API

An Octokit instance

+

payload

payload: EmitterWebhookEvent<E>["payload"]

The webhook event payload

+

Accessors

isBot

  • get isBot(): boolean

  • Returns a boolean if the actor on the event was a bot.

    +

    Returns boolean

Methods

config

  • config<T>(fileName, defaultConfig?, deepMergeOptions?): Promise<null | T>

  • Reads the app configuration from the given YAML file in the .github directory of the repository.

    For example, given a file named .github/config.yml:

    close: true
@@ -43,25 +43,25 @@
  • OptionaldefaultConfig: T

    An object of default config options

  • OptionaldeepMergeOptions: Options

    Controls merging configs (from the deepmerge module)

Returns Promise<null | T>

Configuration object read from the file

-

issue

  • issue<T>(object?): RepoResultType<E> & {
        issue_number: RepoIssueNumberType<E>;
    } & T

  • Return the owner, repo, and issue_number params for making API requests +

issue

  • issue<T>(object?): RepoResultType<E> & {
        issue_number: RepoIssueNumberType<E>;
    } & T

  • Return the owner, repo, and issue_number params for making API requests against an issue. The object passed in will be merged with the repo params.

    const params = context.issue({body: 'Hello World!'})
    // Returns: {owner: 'username', repo: 'reponame', issue_number: 123, body: 'Hello World!'}

    Type Parameters

    • T

    Parameters

    • Optionalobject: T

      Params to be merged with the issue params.

      -

    Returns RepoResultType<E> & {
        issue_number: RepoIssueNumberType<E>;
    } & T

pullRequest

  • pullRequest<T>(object?): RepoResultType<E> & {
        pull_number: RepoIssueNumberType<E>;
    } & T

  • Return the owner, repo, and pull_number params for making API requests +

Returns RepoResultType<E> & {
    issue_number: RepoIssueNumberType<E>;
} & T

pullRequest

  • pullRequest<T>(object?): RepoResultType<E> & {
        pull_number: RepoIssueNumberType<E>;
    } & T

  • Return the owner, repo, and pull_number params for making API requests against a pull request. The object passed in will be merged with the repo params.

    const params = context.pullRequest({body: 'Hello World!'})
    // Returns: {owner: 'username', repo: 'reponame', pull_number: 123, body: 'Hello World!'}

    Type Parameters

    • T

    Parameters

    • Optionalobject: T

      Params to be merged with the pull request params.

      -

    Returns RepoResultType<E> & {
        pull_number: RepoIssueNumberType<E>;
    } & T

repo

  • repo<T>(object?): RepoResultType<E> & T

  • Return the owner and repo params for making API requests against a +

Returns RepoResultType<E> & {
    pull_number: RepoIssueNumberType<E>;
} & T

repo

  • repo<T>(object?): RepoResultType<E> & T

  • Return the owner and repo params for making API requests against a repository.

    const params = context.repo({path: '.github/config.yml'})
    // Returns: {owner: 'username', repo: 'reponame', path: '.github/config.yml'}

    Type Parameters

    • T

    Parameters

    • Optionalobject: T

      Params to be merged with the repo params.

      -

    Returns RepoResultType<E> & T

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/api/13.3.6/classes/manifest_creation.ManifestCreation.html b/api/13.3.6/classes/manifest_creation.ManifestCreation.html index 4b539b07c0b..20ba84b81c0 100644 --- a/api/13.3.6/classes/manifest_creation.ManifestCreation.html +++ b/api/13.3.6/classes/manifest_creation.ManifestCreation.html @@ -1,11 +1,11 @@ -ManifestCreation | probot

Class ManifestCreation

Constructors

constructor +ManifestCreation | probot

Class ManifestCreation

Constructors

constructor

Accessors

createAppUrl pkg

Methods

createAppFromCode createWebhookChannel getManifest updateEnv -

Constructors

constructor

Accessors

createAppUrl

pkg

Methods

createAppFromCode

  • createAppFromCode(code, probotOptions?): Promise<any>

  • Parameters

    • code: string
    • OptionalprobotOptions: OctokitOptions

    Returns Promise<any>

createWebhookChannel

getManifest

updateEnv

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
diff --git a/api/13.3.6/classes/probot.Probot.html b/api/13.3.6/classes/probot.Probot.html index 41a93da26cb..d2705a10447 100644 --- a/api/13.3.6/classes/probot.Probot.html +++ b/api/13.3.6/classes/probot.Probot.html @@ -1,4 +1,4 @@ -Probot | probot

Class Probot

Constructors

constructor +Probot | probot

Class Probot

Constructors

constructor

Properties

auth log on @@ -11,7 +11,7 @@

Methods

load receive defaults -

Constructors

constructor

Properties

auth

auth: ((installationId?: number, log?: Logger) => Promise<Octokit & {} & {} & RestEndpointMethods & Api & API>)

log

log: Logger

on

on: (<E>(event: E | E[], callback: HandlerFunction<E, SimplifiedObject>) => void)

onAny

onAny: ((callback: ((event: EmitterWebhookEvent) => any)) => void)

onError

onError: ((callback: ((event: WebhookEventHandlerError<SimplifiedObject>) => any)) => void)

version

version: String

webhookPath

webhookPath: string

webhooks

webhooks: ProbotWebhooks

Staticversion

version: string = VERSION

Methods

load

receive

  • receive(event): Promise<void>

  • Parameters

    • event: EmitterWebhookEvent

    Returns Promise<void>

Staticdefaults

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/13.3.6/classes/server_server.Server.html b/api/13.3.6/classes/server_server.Server.html index c647d791e88..c731a281167 100644 --- a/api/13.3.6/classes/server_server.Server.html +++ b/api/13.3.6/classes/server_server.Server.html @@ -1,4 +1,4 @@ -Server | probot

Class Server

Constructors

constructor +Server | probot

Class Server

Constructors

constructor

Properties

expressApp log probotApp @@ -8,7 +8,7 @@ router start stop -

Constructors

constructor

Properties

expressApp

expressApp: Application

log

log: Logger

probotApp

probotApp: Probot

version

version: string = VERSION

Staticversion

version: string = VERSION

Methods

load

router

start

  • start(): Promise<Server<typeof IncomingMessage, typeof ServerResponse>>

  • Returns Promise<Server<typeof IncomingMessage, typeof ServerResponse>>

stop

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/13.3.6/functions/apps_default.defaultApp.html b/api/13.3.6/functions/apps_default.defaultApp.html index b0e22e32a1b..186c2243526 100644 --- a/api/13.3.6/functions/apps_default.defaultApp.html +++ b/api/13.3.6/functions/apps_default.defaultApp.html @@ -1,4 +1,4 @@ -defaultApp | probot

Function defaultApp

Settings

Member Visibility

Function defaultApp

Settings

Member Visibility
diff --git a/api/13.3.6/functions/apps_setup.setupAppFactory.html b/api/13.3.6/functions/apps_setup.setupAppFactory.html index 67e953bcfb4..eae93e3d54f 100644 --- a/api/13.3.6/functions/apps_setup.setupAppFactory.html +++ b/api/13.3.6/functions/apps_setup.setupAppFactory.html @@ -1,4 +1,4 @@ -setupAppFactory | probot

Function setupAppFactory

Settings

Member Visibility

Function setupAppFactory

Settings

Member Visibility
diff --git a/api/13.3.6/functions/auth.auth.html b/api/13.3.6/functions/auth.auth.html index efef2b9a108..a62cfe24ee6 100644 --- a/api/13.3.6/functions/auth.auth.html +++ b/api/13.3.6/functions/auth.auth.html @@ -8,7 +8,7 @@

Parameters

  • state: State

    Probot application instance state, which is used to persist

  • OptionalinstallationId: number

Returns Promise<InstanceType<typeof ProbotOctokit>>

An authenticated GitHub API client

-

Settings

Member Visibility
diff --git a/api/13.3.6/functions/bin_read_cli_options.readCliOptions.html b/api/13.3.6/functions/bin_read_cli_options.readCliOptions.html index 3d0f4c6ea55..2620e3832c5 100644 --- a/api/13.3.6/functions/bin_read_cli_options.readCliOptions.html +++ b/api/13.3.6/functions/bin_read_cli_options.readCliOptions.html @@ -1,4 +1,4 @@ -readCliOptions | probot

Function readCliOptions

Settings

Member Visibility

Function readCliOptions

Settings

Member Visibility
diff --git a/api/13.3.6/functions/bin_read_env_options.readEnvOptions.html b/api/13.3.6/functions/bin_read_env_options.readEnvOptions.html index 9f21598ea28..423f6128fcc 100644 --- a/api/13.3.6/functions/bin_read_env_options.readEnvOptions.html +++ b/api/13.3.6/functions/bin_read_env_options.readEnvOptions.html @@ -1,4 +1,4 @@ -readEnvOptions | probot

Function readEnvOptions

  • readEnvOptions(env?): {
        appId: number;
        args: never[];
        baseUrl: string;
        host: undefined | string;
        logFormat: "json" | "pretty";
        logLevel: LogLevel;
        logLevelInString: boolean;
        logMessageKey: undefined | string;
        port: number;
        privateKey: undefined | string;
        redisConfig: undefined | string;
        secret: undefined | string;
        sentryDsn: undefined | string;
        webhookPath: undefined | string;
        webhookProxy: undefined | string;
    }

  • Parameters

    • env: ProcessEnv = process.env

    Returns {
        appId: number;
        args: never[];
        baseUrl: string;
        host: undefined | string;
        logFormat: "json" | "pretty";
        logLevel: LogLevel;
        logLevelInString: boolean;
        logMessageKey: undefined | string;
        port: number;
        privateKey: undefined | string;
        redisConfig: undefined | string;
        secret: undefined | string;
        sentryDsn: undefined | string;
        webhookPath: undefined | string;
        webhookProxy: undefined | string;
    }

    • appId: number
    • args: never[]
    • baseUrl: string
    • host: undefined | string
    • logFormat: "json" | "pretty"
    • logLevel: LogLevel
    • logLevelInString: boolean
    • logMessageKey: undefined | string
    • port: number
    • privateKey: undefined | string
    • redisConfig: undefined | string
    • secret: undefined | string
    • sentryDsn: undefined | string
    • webhookPath: undefined | string
    • webhookProxy: undefined | string

Settings

Member Visibility

Function readEnvOptions

  • readEnvOptions(env?): {
        appId: number;
        args: never[];
        baseUrl: string;
        host: undefined | string;
        logFormat: "json" | "pretty";
        logLevel: LogLevel;
        logLevelInString: boolean;
        logMessageKey: undefined | string;
        port: number;
        privateKey: undefined | string;
        redisConfig: undefined | string;
        secret: undefined | string;
        sentryDsn: undefined | string;
        webhookPath: undefined | string;
        webhookProxy: undefined | string;
    }

  • Parameters

    • env: ProcessEnv = process.env

    Returns {
        appId: number;
        args: never[];
        baseUrl: string;
        host: undefined | string;
        logFormat: "json" | "pretty";
        logLevel: LogLevel;
        logLevelInString: boolean;
        logMessageKey: undefined | string;
        port: number;
        privateKey: undefined | string;
        redisConfig: undefined | string;
        secret: undefined | string;
        sentryDsn: undefined | string;
        webhookPath: undefined | string;
        webhookProxy: undefined | string;
    }

    • appId: number
    • args: never[]
    • baseUrl: string
    • host: undefined | string
    • logFormat: "json" | "pretty"
    • logLevel: LogLevel
    • logLevelInString: boolean
    • logMessageKey: undefined | string
    • port: number
    • privateKey: undefined | string
    • redisConfig: undefined | string
    • secret: undefined | string
    • sentryDsn: undefined | string
    • webhookPath: undefined | string
    • webhookProxy: undefined | string

Settings

Member Visibility
diff --git a/api/13.3.6/functions/create_node_middleware.createNodeMiddleware.html b/api/13.3.6/functions/create_node_middleware.createNodeMiddleware.html index 67a07faa595..1e3e1371719 100644 --- a/api/13.3.6/functions/create_node_middleware.createNodeMiddleware.html +++ b/api/13.3.6/functions/create_node_middleware.createNodeMiddleware.html @@ -1,4 +1,4 @@ -createNodeMiddleware | probot

Function createNodeMiddleware

Settings

Member Visibility

Function createNodeMiddleware

Settings

Member Visibility
diff --git a/api/13.3.6/functions/create_probot.createProbot.html b/api/13.3.6/functions/create_probot.createProbot.html index 9831097ae67..d6009c1cc93 100644 --- a/api/13.3.6/functions/create_probot.createProbot.html +++ b/api/13.3.6/functions/create_probot.createProbot.html @@ -1,7 +1,7 @@ createProbot | probot

Function createProbot

Settings

Member Visibility
diff --git a/api/13.3.6/functions/get_router.getRouter.html b/api/13.3.6/functions/get_router.getRouter.html index 45d4253c372..b59961f1ff5 100644 --- a/api/13.3.6/functions/get_router.getRouter.html +++ b/api/13.3.6/functions/get_router.getRouter.html @@ -2,7 +2,7 @@ expose HTTP endpoints

Parameters

  • router: Router
  • Optionalpath: string

    the prefix for the routes

Returns Router

an express.Router

-

Settings

Member Visibility
diff --git a/api/13.3.6/functions/helpers_get_error_handler.getErrorHandler.html b/api/13.3.6/functions/helpers_get_error_handler.getErrorHandler.html index ef4a9b5cfb0..d51f32296ff 100644 --- a/api/13.3.6/functions/helpers_get_error_handler.getErrorHandler.html +++ b/api/13.3.6/functions/helpers_get_error_handler.getErrorHandler.html @@ -1,4 +1,4 @@ -getErrorHandler | probot

Function getErrorHandler

  • getErrorHandler(log): ((error: Error & {
        event?: EmitterWebhookEvent;
    }) => void)

  • Parameters

    • log: Logger

    Returns ((error: Error & {
        event?: EmitterWebhookEvent;
    }) => void)

      • (error): void

      • Parameters

        • error: Error & {
              event?: EmitterWebhookEvent;
          }

        Returns void

Settings

Member Visibility

Function getErrorHandler

  • getErrorHandler(log): ((error: Error & {
        event?: EmitterWebhookEvent;
    }) => void)

  • Parameters

    • log: Logger

    Returns ((error: Error & {
        event?: EmitterWebhookEvent;
    }) => void)

      • (error): void

      • Parameters

        • error: Error & {
              event?: EmitterWebhookEvent;
          }

        Returns void

Settings

Member Visibility
diff --git a/api/13.3.6/functions/helpers_get_log.getLog.html b/api/13.3.6/functions/helpers_get_log.getLog.html index ca54d7d7a35..3a07a456b12 100644 --- a/api/13.3.6/functions/helpers_get_log.getLog.html +++ b/api/13.3.6/functions/helpers_get_log.getLog.html @@ -1,4 +1,4 @@ -getLog | probot

Function getLog

Settings

Member Visibility

Function getLog

Settings

Member Visibility
diff --git a/api/13.3.6/functions/helpers_is_production.isProduction.html b/api/13.3.6/functions/helpers_is_production.isProduction.html index 1caec467563..e52c13818f3 100644 --- a/api/13.3.6/functions/helpers_is_production.isProduction.html +++ b/api/13.3.6/functions/helpers_is_production.isProduction.html @@ -1,4 +1,4 @@ -isProduction | probot

Function isProduction

Settings

Member Visibility

Function isProduction

Settings

Member Visibility
diff --git a/api/13.3.6/functions/helpers_is_supported_node_version.isSupportedNodeVersion.html b/api/13.3.6/functions/helpers_is_supported_node_version.isSupportedNodeVersion.html index 5225b81620f..90da4e1284f 100644 --- a/api/13.3.6/functions/helpers_is_supported_node_version.isSupportedNodeVersion.html +++ b/api/13.3.6/functions/helpers_is_supported_node_version.isSupportedNodeVersion.html @@ -1,4 +1,4 @@ -isSupportedNodeVersion | probot

Function isSupportedNodeVersion

Settings

Member Visibility

Function isSupportedNodeVersion

Settings

Member Visibility
diff --git a/api/13.3.6/functions/helpers_load_package_json.loadPackageJson.html b/api/13.3.6/functions/helpers_load_package_json.loadPackageJson.html index a37cbff9804..a67a7533ef0 100644 --- a/api/13.3.6/functions/helpers_load_package_json.loadPackageJson.html +++ b/api/13.3.6/functions/helpers_load_package_json.loadPackageJson.html @@ -1,4 +1,4 @@ -loadPackageJson | probot

Function loadPackageJson

Settings

Member Visibility

Function loadPackageJson

Settings

Member Visibility
diff --git a/api/13.3.6/functions/helpers_rebind_log.rebindLog.html b/api/13.3.6/functions/helpers_rebind_log.rebindLog.html index 8b1ad56f258..8f7bcfd5b19 100644 --- a/api/13.3.6/functions/helpers_rebind_log.rebindLog.html +++ b/api/13.3.6/functions/helpers_rebind_log.rebindLog.html @@ -1,4 +1,4 @@ -rebindLog | probot

Function rebindLog

Settings

Member Visibility

Function rebindLog

Settings

Member Visibility
diff --git a/api/13.3.6/functions/helpers_resolve_app_function.resolveAppFunction.html b/api/13.3.6/functions/helpers_resolve_app_function.resolveAppFunction.html index 642f3e7a0f8..ad55f522a05 100644 --- a/api/13.3.6/functions/helpers_resolve_app_function.resolveAppFunction.html +++ b/api/13.3.6/functions/helpers_resolve_app_function.resolveAppFunction.html @@ -1,4 +1,4 @@ -resolveAppFunction | probot

Function resolveAppFunction

Settings

Member Visibility

Function resolveAppFunction

Settings

Member Visibility
diff --git a/api/13.3.6/functions/helpers_webhook_proxy.createWebhookProxy.html b/api/13.3.6/functions/helpers_webhook_proxy.createWebhookProxy.html index 9ab4e4e1fdf..8e68c298f38 100644 --- a/api/13.3.6/functions/helpers_webhook_proxy.createWebhookProxy.html +++ b/api/13.3.6/functions/helpers_webhook_proxy.createWebhookProxy.html @@ -1,4 +1,4 @@ -createWebhookProxy | probot

Function createWebhookProxy

Settings

Member Visibility

Function createWebhookProxy

Settings

Member Visibility
diff --git a/api/13.3.6/functions/octokit_get_authenticated_octokit.getAuthenticatedOctokit.html b/api/13.3.6/functions/octokit_get_authenticated_octokit.getAuthenticatedOctokit.html index 020d25df66c..9d2c4b1a381 100644 --- a/api/13.3.6/functions/octokit_get_authenticated_octokit.getAuthenticatedOctokit.html +++ b/api/13.3.6/functions/octokit_get_authenticated_octokit.getAuthenticatedOctokit.html @@ -1,4 +1,4 @@ -getAuthenticatedOctokit | probot

Function getAuthenticatedOctokit

  • getAuthenticatedOctokit(state, installationId?): Promise<Octokit & {} & {} & RestEndpointMethods & Api & API>

  • Parameters

    • state: State
    • OptionalinstallationId: number

    Returns Promise<Octokit & {} & {} & RestEndpointMethods & Api & API>

Settings

Member Visibility

Function getAuthenticatedOctokit

  • getAuthenticatedOctokit(state, installationId?): Promise<Octokit & {} & {} & RestEndpointMethods & Api & API>

  • Parameters

    • state: State
    • OptionalinstallationId: number

    Returns Promise<Octokit & {} & {} & RestEndpointMethods & Api & API>

Settings

Member Visibility
diff --git a/api/13.3.6/functions/octokit_get_octokit_throttle_options.getOctokitThrottleOptions.html b/api/13.3.6/functions/octokit_get_octokit_throttle_options.getOctokitThrottleOptions.html index 668e89eb68a..c3c521a6b18 100644 --- a/api/13.3.6/functions/octokit_get_octokit_throttle_options.getOctokitThrottleOptions.html +++ b/api/13.3.6/functions/octokit_get_octokit_throttle_options.getOctokitThrottleOptions.html @@ -1,4 +1,4 @@ -getOctokitThrottleOptions | probot

Function getOctokitThrottleOptions

Settings

Member Visibility

Function getOctokitThrottleOptions

Settings

Member Visibility
diff --git a/api/13.3.6/functions/octokit_get_probot_octokit_with_defaults.getProbotOctokitWithDefaults.html b/api/13.3.6/functions/octokit_get_probot_octokit_with_defaults.getProbotOctokitWithDefaults.html index 25f8d2591d5..77f96d6a27b 100644 --- a/api/13.3.6/functions/octokit_get_probot_octokit_with_defaults.getProbotOctokitWithDefaults.html +++ b/api/13.3.6/functions/octokit_get_probot_octokit_with_defaults.getProbotOctokitWithDefaults.html @@ -5,7 +5,7 @@ deeply when instantiated.

Besides the authentication, the Octokit's baseUrl is set as well when run against a GitHub Enterprise Server with a custom domain.

-

Parameters

  • options: Options

Returns typeof Octokit & Constructor<{} & {} & RestEndpointMethods & Api & API>

Settings

Member Visibility
diff --git a/api/13.3.6/functions/octokit_get_webhooks.getWebhooks.html b/api/13.3.6/functions/octokit_get_webhooks.getWebhooks.html index c400b298ea4..ff3f7586b7d 100644 --- a/api/13.3.6/functions/octokit_get_webhooks.getWebhooks.html +++ b/api/13.3.6/functions/octokit_get_webhooks.getWebhooks.html @@ -1,4 +1,4 @@ -getWebhooks | probot

Function getWebhooks

  • getWebhooks(state): Webhooks<Context<
        | "status"
        | "branch_protection_configuration"
        | "branch_protection_rule.disabled"
        | "branch_protection_rule.enabled"
        | "branch_protection_rule"
        | "branch_protection_rule.created"
        | "branch_protection_rule.deleted"
        | "branch_protection_rule.edited"
        | "check_run"
        | "check_run.completed"
        | "check_run.created"
        | "check_run.requested_action"
        | "check_run.rerequested"
        | "check_suite"
        | "check_suite.completed"
        | "check_suite.requested"
        | "check_suite.rerequested"
        | "code_scanning_alert"
        | "code_scanning_alert.appeared_in_branch"
        | "code_scanning_alert.closed_by_user"
        | "code_scanning_alert.created"
        | "code_scanning_alert.fixed"
        | "code_scanning_alert.reopened"
        | "code_scanning_alert.reopened_by_user"
        | "commit_comment"
        | "commit_comment.created"
        | "create"
        | "custom_property"
        | "custom_property.created"
        | "custom_property.deleted"
        | "custom_property_values"
        | "custom_property_values.updated"
        | "delete"
        | "dependabot_alert"
        | "dependabot_alert.created"
        | "dependabot_alert.dismissed"
        | "dependabot_alert.fixed"
        | "dependabot_alert.reintroduced"
        | "dependabot_alert.reopened"
        | "deploy_key"
        | "deploy_key.created"
        | "deploy_key.deleted"
        | "deployment"
        | "deployment.created"
        | "deployment_protection_rule"
        | "deployment_protection_rule.requested"
        | "deployment_review"
        | "deployment_review.approved"
        | "deployment_review.rejected"
        | "deployment_review.requested"
        | "deployment_status"
        | "deployment_status.created"
        | "discussion"
        | "discussion.answered"
        | "discussion.category_changed"
        | "discussion.created"
        | "discussion.deleted"
        | "discussion.edited"
        | "discussion.labeled"
        | "discussion.locked"
        | "discussion.pinned"
        | "discussion.transferred"
        | "discussion.unanswered"
        | "discussion.unlabeled"
        | "discussion.unlocked"
        | "discussion.unpinned"
        | "discussion_comment"
        | "discussion_comment.created"
        | "discussion_comment.deleted"
        | "discussion_comment.edited"
        | "fork"
        | "github_app_authorization"
        | "github_app_authorization.revoked"
        | "gollum"
        | "installation"
        | "installation.created"
        | "installation.deleted"
        | "installation.new_permissions_accepted"
        | "installation.suspend"
        | "installation.unsuspend"
        | "installation_repositories"
        | "installation_repositories.added"
        | "installation_repositories.removed"
        | "installation_target"
        | "installation_target.renamed"
        | "issue_comment"
        | "issue_comment.created"
        | "issue_comment.deleted"
        | "issue_comment.edited"
        | "issues"
        | "issues.assigned"
        | "issues.closed"
        | "issues.deleted"
        | "issues.demilestoned"
        | "issues.edited"
        | "issues.labeled"
        | "issues.locked"
        | "issues.milestoned"
        | "issues.opened"
        | "issues.pinned"
        | "issues.reopened"
        | "issues.transferred"
        | "issues.unassigned"
        | "issues.unlabeled"
        | "issues.unlocked"
        | "issues.unpinned"
        | "label"
        | "label.created"
        | "label.deleted"
        | "label.edited"
        | "marketplace_purchase"
        | "marketplace_purchase.cancelled"
        | "marketplace_purchase.changed"
        | "marketplace_purchase.pending_change"
        | "marketplace_purchase.pending_change_cancelled"
        | "marketplace_purchase.purchased"
        | "member"
        | "member.added"
        | "member.edited"
        | "member.removed"
        | "membership"
        | "membership.added"
        | "membership.removed"
        | "merge_group"
        | "merge_group.checks_requested"
        | "meta"
        | "meta.deleted"
        | "milestone"
        | "milestone.closed"
        | "milestone.created"
        | "milestone.deleted"
        | "milestone.edited"
        | "milestone.opened"
        | "org_block"
        | "org_block.blocked"
        | "org_block.unblocked"
        | "organization"
        | "organization.deleted"
        | "organization.member_added"
        | "organization.member_invited"
        | "organization.member_removed"
        | "organization.renamed"
        | "package"
        | "package.published"
        | "package.updated"
        | "page_build"
        | "ping"
        | "project"
        | "project.closed"
        | "project.created"
        | "project.deleted"
        | "project.edited"
        | "project.reopened"
        | "project_card"
        | "project_card.converted"
        | "project_card.created"
        | "project_card.deleted"
        | "project_card.edited"
        | "project_card.moved"
        | "project_column"
        | "project_column.created"
        | "project_column.deleted"
        | "project_column.edited"
        | "project_column.moved"
        | "projects_v2_item"
        | "projects_v2_item.archived"
        | "projects_v2_item.converted"
        | "projects_v2_item.created"
        | "projects_v2_item.deleted"
        | "projects_v2_item.edited"
        | "projects_v2_item.reordered"
        | "projects_v2_item.restored"
        | "public"
        | "pull_request"
        | "pull_request.assigned"
        | "pull_request.auto_merge_disabled"
        | "pull_request.auto_merge_enabled"
        | "pull_request.closed"
        | "pull_request.converted_to_draft"
        | "pull_request.demilestoned"
        | "pull_request.dequeued"
        | "pull_request.edited"
        | "pull_request.enqueued"
        | "pull_request.labeled"
        | "pull_request.locked"
        | "pull_request.milestoned"
        | "pull_request.opened"
        | "pull_request.ready_for_review"
        | "pull_request.reopened"
        | "pull_request.review_request_removed"
        | "pull_request.review_requested"
        | "pull_request.synchronize"
        | "pull_request.unassigned"
        | "pull_request.unlabeled"
        | "pull_request.unlocked"
        | "pull_request_review"
        | "pull_request_review.dismissed"
        | "pull_request_review.edited"
        | "pull_request_review.submitted"
        | "pull_request_review_comment"
        | "pull_request_review_comment.created"
        | "pull_request_review_comment.deleted"
        | "pull_request_review_comment.edited"
        | "pull_request_review_thread"
        | "pull_request_review_thread.resolved"
        | "pull_request_review_thread.unresolved"
        | "push"
        | "registry_package"
        | "registry_package.published"
        | "registry_package.updated"
        | "release"
        | "release.created"
        | "release.deleted"
        | "release.edited"
        | "release.prereleased"
        | "release.published"
        | "release.released"
        | "release.unpublished"
        | "repository"
        | "repository.archived"
        | "repository.created"
        | "repository.deleted"
        | "repository.edited"
        | "repository.privatized"
        | "repository.publicized"
        | "repository.renamed"
        | "repository.transferred"
        | "repository.unarchived"
        | "repository_dispatch"
        | "repository_import"
        | "repository_vulnerability_alert"
        | "repository_vulnerability_alert.create"
        | "repository_vulnerability_alert.dismiss"
        | "repository_vulnerability_alert.reopen"
        | "repository_vulnerability_alert.resolve"
        | "secret_scanning_alert"
        | "secret_scanning_alert.created"
        | "secret_scanning_alert.reopened"
        | "secret_scanning_alert.resolved"
        | "secret_scanning_alert.revoked"
        | "secret_scanning_alert_location"
        | "secret_scanning_alert_location.created"
        | "security_advisory"
        | "security_advisory.performed"
        | "security_advisory.published"
        | "security_advisory.updated"
        | "security_advisory.withdrawn"
        | "sponsorship"
        | "sponsorship.cancelled"
        | "sponsorship.created"
        | "sponsorship.edited"
        | "sponsorship.pending_cancellation"
        | "sponsorship.pending_tier_change"
        | "sponsorship.tier_changed"
        | "star"
        | "star.created"
        | "star.deleted"
        | "team"
        | "team.added_to_repository"
        | "team.created"
        | "team.deleted"
        | "team.edited"
        | "team.removed_from_repository"
        | "team_add"
        | "watch"
        | "watch.started"
        | "workflow_dispatch"
        | "workflow_job"
        | "workflow_job.completed"
        | "workflow_job.in_progress"
        | "workflow_job.queued"
        | "workflow_job.waiting"
        | "workflow_run"
        | "workflow_run.completed"
        | "workflow_run.in_progress"
        | "workflow_run.requested">>

  • Parameters

    Returns Webhooks<Context<
        | "status"
        | "branch_protection_configuration"
        | "branch_protection_rule.disabled"
        | "branch_protection_rule.enabled"
        | "branch_protection_rule"
        | "branch_protection_rule.created"
        | "branch_protection_rule.deleted"
        | "branch_protection_rule.edited"
        | "check_run"
        | "check_run.completed"
        | "check_run.created"
        | "check_run.requested_action"
        | "check_run.rerequested"
        | "check_suite"
        | "check_suite.completed"
        | "check_suite.requested"
        | "check_suite.rerequested"
        | "code_scanning_alert"
        | "code_scanning_alert.appeared_in_branch"
        | "code_scanning_alert.closed_by_user"
        | "code_scanning_alert.created"
        | "code_scanning_alert.fixed"
        | "code_scanning_alert.reopened"
        | "code_scanning_alert.reopened_by_user"
        | "commit_comment"
        | "commit_comment.created"
        | "create"
        | "custom_property"
        | "custom_property.created"
        | "custom_property.deleted"
        | "custom_property_values"
        | "custom_property_values.updated"
        | "delete"
        | "dependabot_alert"
        | "dependabot_alert.created"
        | "dependabot_alert.dismissed"
        | "dependabot_alert.fixed"
        | "dependabot_alert.reintroduced"
        | "dependabot_alert.reopened"
        | "deploy_key"
        | "deploy_key.created"
        | "deploy_key.deleted"
        | "deployment"
        | "deployment.created"
        | "deployment_protection_rule"
        | "deployment_protection_rule.requested"
        | "deployment_review"
        | "deployment_review.approved"
        | "deployment_review.rejected"
        | "deployment_review.requested"
        | "deployment_status"
        | "deployment_status.created"
        | "discussion"
        | "discussion.answered"
        | "discussion.category_changed"
        | "discussion.created"
        | "discussion.deleted"
        | "discussion.edited"
        | "discussion.labeled"
        | "discussion.locked"
        | "discussion.pinned"
        | "discussion.transferred"
        | "discussion.unanswered"
        | "discussion.unlabeled"
        | "discussion.unlocked"
        | "discussion.unpinned"
        | "discussion_comment"
        | "discussion_comment.created"
        | "discussion_comment.deleted"
        | "discussion_comment.edited"
        | "fork"
        | "github_app_authorization"
        | "github_app_authorization.revoked"
        | "gollum"
        | "installation"
        | "installation.created"
        | "installation.deleted"
        | "installation.new_permissions_accepted"
        | "installation.suspend"
        | "installation.unsuspend"
        | "installation_repositories"
        | "installation_repositories.added"
        | "installation_repositories.removed"
        | "installation_target"
        | "installation_target.renamed"
        | "issue_comment"
        | "issue_comment.created"
        | "issue_comment.deleted"
        | "issue_comment.edited"
        | "issues"
        | "issues.assigned"
        | "issues.closed"
        | "issues.deleted"
        | "issues.demilestoned"
        | "issues.edited"
        | "issues.labeled"
        | "issues.locked"
        | "issues.milestoned"
        | "issues.opened"
        | "issues.pinned"
        | "issues.reopened"
        | "issues.transferred"
        | "issues.unassigned"
        | "issues.unlabeled"
        | "issues.unlocked"
        | "issues.unpinned"
        | "label"
        | "label.created"
        | "label.deleted"
        | "label.edited"
        | "marketplace_purchase"
        | "marketplace_purchase.cancelled"
        | "marketplace_purchase.changed"
        | "marketplace_purchase.pending_change"
        | "marketplace_purchase.pending_change_cancelled"
        | "marketplace_purchase.purchased"
        | "member"
        | "member.added"
        | "member.edited"
        | "member.removed"
        | "membership"
        | "membership.added"
        | "membership.removed"
        | "merge_group"
        | "merge_group.checks_requested"
        | "meta"
        | "meta.deleted"
        | "milestone"
        | "milestone.closed"
        | "milestone.created"
        | "milestone.deleted"
        | "milestone.edited"
        | "milestone.opened"
        | "org_block"
        | "org_block.blocked"
        | "org_block.unblocked"
        | "organization"
        | "organization.deleted"
        | "organization.member_added"
        | "organization.member_invited"
        | "organization.member_removed"
        | "organization.renamed"
        | "package"
        | "package.published"
        | "package.updated"
        | "page_build"
        | "ping"
        | "project"
        | "project.closed"
        | "project.created"
        | "project.deleted"
        | "project.edited"
        | "project.reopened"
        | "project_card"
        | "project_card.converted"
        | "project_card.created"
        | "project_card.deleted"
        | "project_card.edited"
        | "project_card.moved"
        | "project_column"
        | "project_column.created"
        | "project_column.deleted"
        | "project_column.edited"
        | "project_column.moved"
        | "projects_v2_item"
        | "projects_v2_item.archived"
        | "projects_v2_item.converted"
        | "projects_v2_item.created"
        | "projects_v2_item.deleted"
        | "projects_v2_item.edited"
        | "projects_v2_item.reordered"
        | "projects_v2_item.restored"
        | "public"
        | "pull_request"
        | "pull_request.assigned"
        | "pull_request.auto_merge_disabled"
        | "pull_request.auto_merge_enabled"
        | "pull_request.closed"
        | "pull_request.converted_to_draft"
        | "pull_request.demilestoned"
        | "pull_request.dequeued"
        | "pull_request.edited"
        | "pull_request.enqueued"
        | "pull_request.labeled"
        | "pull_request.locked"
        | "pull_request.milestoned"
        | "pull_request.opened"
        | "pull_request.ready_for_review"
        | "pull_request.reopened"
        | "pull_request.review_request_removed"
        | "pull_request.review_requested"
        | "pull_request.synchronize"
        | "pull_request.unassigned"
        | "pull_request.unlabeled"
        | "pull_request.unlocked"
        | "pull_request_review"
        | "pull_request_review.dismissed"
        | "pull_request_review.edited"
        | "pull_request_review.submitted"
        | "pull_request_review_comment"
        | "pull_request_review_comment.created"
        | "pull_request_review_comment.deleted"
        | "pull_request_review_comment.edited"
        | "pull_request_review_thread"
        | "pull_request_review_thread.resolved"
        | "pull_request_review_thread.unresolved"
        | "push"
        | "registry_package"
        | "registry_package.published"
        | "registry_package.updated"
        | "release"
        | "release.created"
        | "release.deleted"
        | "release.edited"
        | "release.prereleased"
        | "release.published"
        | "release.released"
        | "release.unpublished"
        | "repository"
        | "repository.archived"
        | "repository.created"
        | "repository.deleted"
        | "repository.edited"
        | "repository.privatized"
        | "repository.publicized"
        | "repository.renamed"
        | "repository.transferred"
        | "repository.unarchived"
        | "repository_dispatch"
        | "repository_import"
        | "repository_vulnerability_alert"
        | "repository_vulnerability_alert.create"
        | "repository_vulnerability_alert.dismiss"
        | "repository_vulnerability_alert.reopen"
        | "repository_vulnerability_alert.resolve"
        | "secret_scanning_alert"
        | "secret_scanning_alert.created"
        | "secret_scanning_alert.reopened"
        | "secret_scanning_alert.resolved"
        | "secret_scanning_alert.revoked"
        | "secret_scanning_alert_location"
        | "secret_scanning_alert_location.created"
        | "security_advisory"
        | "security_advisory.performed"
        | "security_advisory.published"
        | "security_advisory.updated"
        | "security_advisory.withdrawn"
        | "sponsorship"
        | "sponsorship.cancelled"
        | "sponsorship.created"
        | "sponsorship.edited"
        | "sponsorship.pending_cancellation"
        | "sponsorship.pending_tier_change"
        | "sponsorship.tier_changed"
        | "star"
        | "star.created"
        | "star.deleted"
        | "team"
        | "team.added_to_repository"
        | "team.created"
        | "team.deleted"
        | "team.edited"
        | "team.removed_from_repository"
        | "team_add"
        | "watch"
        | "watch.started"
        | "workflow_dispatch"
        | "workflow_job"
        | "workflow_job.completed"
        | "workflow_job.in_progress"
        | "workflow_job.queued"
        | "workflow_job.waiting"
        | "workflow_run"
        | "workflow_run.completed"
        | "workflow_run.in_progress"
        | "workflow_run.requested">>

Settings

Member Visibility

Function getWebhooks

  • getWebhooks(state): Webhooks<Context<
        | "status"
        | "branch_protection_configuration"
        | "branch_protection_rule.disabled"
        | "branch_protection_rule.enabled"
        | "branch_protection_rule"
        | "branch_protection_rule.created"
        | "branch_protection_rule.deleted"
        | "branch_protection_rule.edited"
        | "check_run"
        | "check_run.completed"
        | "check_run.created"
        | "check_run.requested_action"
        | "check_run.rerequested"
        | "check_suite"
        | "check_suite.completed"
        | "check_suite.requested"
        | "check_suite.rerequested"
        | "code_scanning_alert"
        | "code_scanning_alert.appeared_in_branch"
        | "code_scanning_alert.closed_by_user"
        | "code_scanning_alert.created"
        | "code_scanning_alert.fixed"
        | "code_scanning_alert.reopened"
        | "code_scanning_alert.reopened_by_user"
        | "commit_comment"
        | "commit_comment.created"
        | "create"
        | "custom_property"
        | "custom_property.created"
        | "custom_property.deleted"
        | "custom_property_values"
        | "custom_property_values.updated"
        | "delete"
        | "dependabot_alert"
        | "dependabot_alert.created"
        | "dependabot_alert.dismissed"
        | "dependabot_alert.fixed"
        | "dependabot_alert.reintroduced"
        | "dependabot_alert.reopened"
        | "deploy_key"
        | "deploy_key.created"
        | "deploy_key.deleted"
        | "deployment"
        | "deployment.created"
        | "deployment_protection_rule"
        | "deployment_protection_rule.requested"
        | "deployment_review"
        | "deployment_review.approved"
        | "deployment_review.rejected"
        | "deployment_review.requested"
        | "deployment_status"
        | "deployment_status.created"
        | "discussion"
        | "discussion.answered"
        | "discussion.category_changed"
        | "discussion.created"
        | "discussion.deleted"
        | "discussion.edited"
        | "discussion.labeled"
        | "discussion.locked"
        | "discussion.pinned"
        | "discussion.transferred"
        | "discussion.unanswered"
        | "discussion.unlabeled"
        | "discussion.unlocked"
        | "discussion.unpinned"
        | "discussion_comment"
        | "discussion_comment.created"
        | "discussion_comment.deleted"
        | "discussion_comment.edited"
        | "fork"
        | "github_app_authorization"
        | "github_app_authorization.revoked"
        | "gollum"
        | "installation"
        | "installation.created"
        | "installation.deleted"
        | "installation.new_permissions_accepted"
        | "installation.suspend"
        | "installation.unsuspend"
        | "installation_repositories"
        | "installation_repositories.added"
        | "installation_repositories.removed"
        | "installation_target"
        | "installation_target.renamed"
        | "issue_comment"
        | "issue_comment.created"
        | "issue_comment.deleted"
        | "issue_comment.edited"
        | "issues"
        | "issues.assigned"
        | "issues.closed"
        | "issues.deleted"
        | "issues.demilestoned"
        | "issues.edited"
        | "issues.labeled"
        | "issues.locked"
        | "issues.milestoned"
        | "issues.opened"
        | "issues.pinned"
        | "issues.reopened"
        | "issues.transferred"
        | "issues.unassigned"
        | "issues.unlabeled"
        | "issues.unlocked"
        | "issues.unpinned"
        | "label"
        | "label.created"
        | "label.deleted"
        | "label.edited"
        | "marketplace_purchase"
        | "marketplace_purchase.cancelled"
        | "marketplace_purchase.changed"
        | "marketplace_purchase.pending_change"
        | "marketplace_purchase.pending_change_cancelled"
        | "marketplace_purchase.purchased"
        | "member"
        | "member.added"
        | "member.edited"
        | "member.removed"
        | "membership"
        | "membership.added"
        | "membership.removed"
        | "merge_group"
        | "merge_group.checks_requested"
        | "meta"
        | "meta.deleted"
        | "milestone"
        | "milestone.closed"
        | "milestone.created"
        | "milestone.deleted"
        | "milestone.edited"
        | "milestone.opened"
        | "org_block"
        | "org_block.blocked"
        | "org_block.unblocked"
        | "organization"
        | "organization.deleted"
        | "organization.member_added"
        | "organization.member_invited"
        | "organization.member_removed"
        | "organization.renamed"
        | "package"
        | "package.published"
        | "package.updated"
        | "page_build"
        | "ping"
        | "project"
        | "project.closed"
        | "project.created"
        | "project.deleted"
        | "project.edited"
        | "project.reopened"
        | "project_card"
        | "project_card.converted"
        | "project_card.created"
        | "project_card.deleted"
        | "project_card.edited"
        | "project_card.moved"
        | "project_column"
        | "project_column.created"
        | "project_column.deleted"
        | "project_column.edited"
        | "project_column.moved"
        | "projects_v2_item"
        | "projects_v2_item.archived"
        | "projects_v2_item.converted"
        | "projects_v2_item.created"
        | "projects_v2_item.deleted"
        | "projects_v2_item.edited"
        | "projects_v2_item.reordered"
        | "projects_v2_item.restored"
        | "public"
        | "pull_request"
        | "pull_request.assigned"
        | "pull_request.auto_merge_disabled"
        | "pull_request.auto_merge_enabled"
        | "pull_request.closed"
        | "pull_request.converted_to_draft"
        | "pull_request.demilestoned"
        | "pull_request.dequeued"
        | "pull_request.edited"
        | "pull_request.enqueued"
        | "pull_request.labeled"
        | "pull_request.locked"
        | "pull_request.milestoned"
        | "pull_request.opened"
        | "pull_request.ready_for_review"
        | "pull_request.reopened"
        | "pull_request.review_request_removed"
        | "pull_request.review_requested"
        | "pull_request.synchronize"
        | "pull_request.unassigned"
        | "pull_request.unlabeled"
        | "pull_request.unlocked"
        | "pull_request_review"
        | "pull_request_review.dismissed"
        | "pull_request_review.edited"
        | "pull_request_review.submitted"
        | "pull_request_review_comment"
        | "pull_request_review_comment.created"
        | "pull_request_review_comment.deleted"
        | "pull_request_review_comment.edited"
        | "pull_request_review_thread"
        | "pull_request_review_thread.resolved"
        | "pull_request_review_thread.unresolved"
        | "push"
        | "registry_package"
        | "registry_package.published"
        | "registry_package.updated"
        | "release"
        | "release.created"
        | "release.deleted"
        | "release.edited"
        | "release.prereleased"
        | "release.published"
        | "release.released"
        | "release.unpublished"
        | "repository"
        | "repository.archived"
        | "repository.created"
        | "repository.deleted"
        | "repository.edited"
        | "repository.privatized"
        | "repository.publicized"
        | "repository.renamed"
        | "repository.transferred"
        | "repository.unarchived"
        | "repository_dispatch"
        | "repository_import"
        | "repository_vulnerability_alert"
        | "repository_vulnerability_alert.create"
        | "repository_vulnerability_alert.dismiss"
        | "repository_vulnerability_alert.reopen"
        | "repository_vulnerability_alert.resolve"
        | "secret_scanning_alert"
        | "secret_scanning_alert.created"
        | "secret_scanning_alert.reopened"
        | "secret_scanning_alert.resolved"
        | "secret_scanning_alert.revoked"
        | "secret_scanning_alert_location"
        | "secret_scanning_alert_location.created"
        | "security_advisory"
        | "security_advisory.performed"
        | "security_advisory.published"
        | "security_advisory.updated"
        | "security_advisory.withdrawn"
        | "sponsorship"
        | "sponsorship.cancelled"
        | "sponsorship.created"
        | "sponsorship.edited"
        | "sponsorship.pending_cancellation"
        | "sponsorship.pending_tier_change"
        | "sponsorship.tier_changed"
        | "star"
        | "star.created"
        | "star.deleted"
        | "team"
        | "team.added_to_repository"
        | "team.created"
        | "team.deleted"
        | "team.edited"
        | "team.removed_from_repository"
        | "team_add"
        | "watch"
        | "watch.started"
        | "workflow_dispatch"
        | "workflow_job"
        | "workflow_job.completed"
        | "workflow_job.in_progress"
        | "workflow_job.queued"
        | "workflow_job.waiting"
        | "workflow_run"
        | "workflow_run.completed"
        | "workflow_run.in_progress"
        | "workflow_run.requested">>

  • Parameters

    Returns Webhooks<Context<
        | "status"
        | "branch_protection_configuration"
        | "branch_protection_rule.disabled"
        | "branch_protection_rule.enabled"
        | "branch_protection_rule"
        | "branch_protection_rule.created"
        | "branch_protection_rule.deleted"
        | "branch_protection_rule.edited"
        | "check_run"
        | "check_run.completed"
        | "check_run.created"
        | "check_run.requested_action"
        | "check_run.rerequested"
        | "check_suite"
        | "check_suite.completed"
        | "check_suite.requested"
        | "check_suite.rerequested"
        | "code_scanning_alert"
        | "code_scanning_alert.appeared_in_branch"
        | "code_scanning_alert.closed_by_user"
        | "code_scanning_alert.created"
        | "code_scanning_alert.fixed"
        | "code_scanning_alert.reopened"
        | "code_scanning_alert.reopened_by_user"
        | "commit_comment"
        | "commit_comment.created"
        | "create"
        | "custom_property"
        | "custom_property.created"
        | "custom_property.deleted"
        | "custom_property_values"
        | "custom_property_values.updated"
        | "delete"
        | "dependabot_alert"
        | "dependabot_alert.created"
        | "dependabot_alert.dismissed"
        | "dependabot_alert.fixed"
        | "dependabot_alert.reintroduced"
        | "dependabot_alert.reopened"
        | "deploy_key"
        | "deploy_key.created"
        | "deploy_key.deleted"
        | "deployment"
        | "deployment.created"
        | "deployment_protection_rule"
        | "deployment_protection_rule.requested"
        | "deployment_review"
        | "deployment_review.approved"
        | "deployment_review.rejected"
        | "deployment_review.requested"
        | "deployment_status"
        | "deployment_status.created"
        | "discussion"
        | "discussion.answered"
        | "discussion.category_changed"
        | "discussion.created"
        | "discussion.deleted"
        | "discussion.edited"
        | "discussion.labeled"
        | "discussion.locked"
        | "discussion.pinned"
        | "discussion.transferred"
        | "discussion.unanswered"
        | "discussion.unlabeled"
        | "discussion.unlocked"
        | "discussion.unpinned"
        | "discussion_comment"
        | "discussion_comment.created"
        | "discussion_comment.deleted"
        | "discussion_comment.edited"
        | "fork"
        | "github_app_authorization"
        | "github_app_authorization.revoked"
        | "gollum"
        | "installation"
        | "installation.created"
        | "installation.deleted"
        | "installation.new_permissions_accepted"
        | "installation.suspend"
        | "installation.unsuspend"
        | "installation_repositories"
        | "installation_repositories.added"
        | "installation_repositories.removed"
        | "installation_target"
        | "installation_target.renamed"
        | "issue_comment"
        | "issue_comment.created"
        | "issue_comment.deleted"
        | "issue_comment.edited"
        | "issues"
        | "issues.assigned"
        | "issues.closed"
        | "issues.deleted"
        | "issues.demilestoned"
        | "issues.edited"
        | "issues.labeled"
        | "issues.locked"
        | "issues.milestoned"
        | "issues.opened"
        | "issues.pinned"
        | "issues.reopened"
        | "issues.transferred"
        | "issues.unassigned"
        | "issues.unlabeled"
        | "issues.unlocked"
        | "issues.unpinned"
        | "label"
        | "label.created"
        | "label.deleted"
        | "label.edited"
        | "marketplace_purchase"
        | "marketplace_purchase.cancelled"
        | "marketplace_purchase.changed"
        | "marketplace_purchase.pending_change"
        | "marketplace_purchase.pending_change_cancelled"
        | "marketplace_purchase.purchased"
        | "member"
        | "member.added"
        | "member.edited"
        | "member.removed"
        | "membership"
        | "membership.added"
        | "membership.removed"
        | "merge_group"
        | "merge_group.checks_requested"
        | "meta"
        | "meta.deleted"
        | "milestone"
        | "milestone.closed"
        | "milestone.created"
        | "milestone.deleted"
        | "milestone.edited"
        | "milestone.opened"
        | "org_block"
        | "org_block.blocked"
        | "org_block.unblocked"
        | "organization"
        | "organization.deleted"
        | "organization.member_added"
        | "organization.member_invited"
        | "organization.member_removed"
        | "organization.renamed"
        | "package"
        | "package.published"
        | "package.updated"
        | "page_build"
        | "ping"
        | "project"
        | "project.closed"
        | "project.created"
        | "project.deleted"
        | "project.edited"
        | "project.reopened"
        | "project_card"
        | "project_card.converted"
        | "project_card.created"
        | "project_card.deleted"
        | "project_card.edited"
        | "project_card.moved"
        | "project_column"
        | "project_column.created"
        | "project_column.deleted"
        | "project_column.edited"
        | "project_column.moved"
        | "projects_v2_item"
        | "projects_v2_item.archived"
        | "projects_v2_item.converted"
        | "projects_v2_item.created"
        | "projects_v2_item.deleted"
        | "projects_v2_item.edited"
        | "projects_v2_item.reordered"
        | "projects_v2_item.restored"
        | "public"
        | "pull_request"
        | "pull_request.assigned"
        | "pull_request.auto_merge_disabled"
        | "pull_request.auto_merge_enabled"
        | "pull_request.closed"
        | "pull_request.converted_to_draft"
        | "pull_request.demilestoned"
        | "pull_request.dequeued"
        | "pull_request.edited"
        | "pull_request.enqueued"
        | "pull_request.labeled"
        | "pull_request.locked"
        | "pull_request.milestoned"
        | "pull_request.opened"
        | "pull_request.ready_for_review"
        | "pull_request.reopened"
        | "pull_request.review_request_removed"
        | "pull_request.review_requested"
        | "pull_request.synchronize"
        | "pull_request.unassigned"
        | "pull_request.unlabeled"
        | "pull_request.unlocked"
        | "pull_request_review"
        | "pull_request_review.dismissed"
        | "pull_request_review.edited"
        | "pull_request_review.submitted"
        | "pull_request_review_comment"
        | "pull_request_review_comment.created"
        | "pull_request_review_comment.deleted"
        | "pull_request_review_comment.edited"
        | "pull_request_review_thread"
        | "pull_request_review_thread.resolved"
        | "pull_request_review_thread.unresolved"
        | "push"
        | "registry_package"
        | "registry_package.published"
        | "registry_package.updated"
        | "release"
        | "release.created"
        | "release.deleted"
        | "release.edited"
        | "release.prereleased"
        | "release.published"
        | "release.released"
        | "release.unpublished"
        | "repository"
        | "repository.archived"
        | "repository.created"
        | "repository.deleted"
        | "repository.edited"
        | "repository.privatized"
        | "repository.publicized"
        | "repository.renamed"
        | "repository.transferred"
        | "repository.unarchived"
        | "repository_dispatch"
        | "repository_import"
        | "repository_vulnerability_alert"
        | "repository_vulnerability_alert.create"
        | "repository_vulnerability_alert.dismiss"
        | "repository_vulnerability_alert.reopen"
        | "repository_vulnerability_alert.resolve"
        | "secret_scanning_alert"
        | "secret_scanning_alert.created"
        | "secret_scanning_alert.reopened"
        | "secret_scanning_alert.resolved"
        | "secret_scanning_alert.revoked"
        | "secret_scanning_alert_location"
        | "secret_scanning_alert_location.created"
        | "security_advisory"
        | "security_advisory.performed"
        | "security_advisory.published"
        | "security_advisory.updated"
        | "security_advisory.withdrawn"
        | "sponsorship"
        | "sponsorship.cancelled"
        | "sponsorship.created"
        | "sponsorship.edited"
        | "sponsorship.pending_cancellation"
        | "sponsorship.pending_tier_change"
        | "sponsorship.tier_changed"
        | "star"
        | "star.created"
        | "star.deleted"
        | "team"
        | "team.added_to_repository"
        | "team.created"
        | "team.deleted"
        | "team.edited"
        | "team.removed_from_repository"
        | "team_add"
        | "watch"
        | "watch.started"
        | "workflow_dispatch"
        | "workflow_job"
        | "workflow_job.completed"
        | "workflow_job.in_progress"
        | "workflow_job.queued"
        | "workflow_job.waiting"
        | "workflow_run"
        | "workflow_run.completed"
        | "workflow_run.in_progress"
        | "workflow_run.requested">>

Settings

Member Visibility
diff --git a/api/13.3.6/functions/octokit_octokit_plugin_probot_request_logging.probotRequestLogging.html b/api/13.3.6/functions/octokit_octokit_plugin_probot_request_logging.probotRequestLogging.html index cbbd5c2b03b..063f57f3c8e 100644 --- a/api/13.3.6/functions/octokit_octokit_plugin_probot_request_logging.probotRequestLogging.html +++ b/api/13.3.6/functions/octokit_octokit_plugin_probot_request_logging.probotRequestLogging.html @@ -1,4 +1,4 @@ -probotRequestLogging | probot

Function probotRequestLogging

Settings

Member Visibility

Function probotRequestLogging

Settings

Member Visibility
diff --git a/api/13.3.6/functions/octokit_octokit_webhooks_transform.webhookTransform.html b/api/13.3.6/functions/octokit_octokit_webhooks_transform.webhookTransform.html index 2f1b747debd..8bf588816bb 100644 --- a/api/13.3.6/functions/octokit_octokit_webhooks_transform.webhookTransform.html +++ b/api/13.3.6/functions/octokit_octokit_webhooks_transform.webhookTransform.html @@ -1,7 +1,7 @@ webhookTransform | probot

Function webhookTransform

  • webhookTransform(state, event): Promise<Context<
        | "status"
        | "branch_protection_configuration"
        | "branch_protection_rule.disabled"
        | "branch_protection_rule.enabled"
        | "branch_protection_rule"
        | "branch_protection_rule.created"
        | "branch_protection_rule.deleted"
        | "branch_protection_rule.edited"
        | "check_run"
        | "check_run.completed"
        | "check_run.created"
        | "check_run.requested_action"
        | "check_run.rerequested"
        | "check_suite"
        | "check_suite.completed"
        | "check_suite.requested"
        | "check_suite.rerequested"
        | "code_scanning_alert"
        | "code_scanning_alert.appeared_in_branch"
        | "code_scanning_alert.closed_by_user"
        | "code_scanning_alert.created"
        | "code_scanning_alert.fixed"
        | "code_scanning_alert.reopened"
        | "code_scanning_alert.reopened_by_user"
        | "commit_comment"
        | "commit_comment.created"
        | "create"
        | "custom_property"
        | "custom_property.created"
        | "custom_property.deleted"
        | "custom_property_values"
        | "custom_property_values.updated"
        | "delete"
        | "dependabot_alert"
        | "dependabot_alert.created"
        | "dependabot_alert.dismissed"
        | "dependabot_alert.fixed"
        | "dependabot_alert.reintroduced"
        | "dependabot_alert.reopened"
        | "deploy_key"
        | "deploy_key.created"
        | "deploy_key.deleted"
        | "deployment"
        | "deployment.created"
        | "deployment_protection_rule"
        | "deployment_protection_rule.requested"
        | "deployment_review"
        | "deployment_review.approved"
        | "deployment_review.rejected"
        | "deployment_review.requested"
        | "deployment_status"
        | "deployment_status.created"
        | "discussion"
        | "discussion.answered"
        | "discussion.category_changed"
        | "discussion.created"
        | "discussion.deleted"
        | "discussion.edited"
        | "discussion.labeled"
        | "discussion.locked"
        | "discussion.pinned"
        | "discussion.transferred"
        | "discussion.unanswered"
        | "discussion.unlabeled"
        | "discussion.unlocked"
        | "discussion.unpinned"
        | "discussion_comment"
        | "discussion_comment.created"
        | "discussion_comment.deleted"
        | "discussion_comment.edited"
        | "fork"
        | "github_app_authorization"
        | "github_app_authorization.revoked"
        | "gollum"
        | "installation"
        | "installation.created"
        | "installation.deleted"
        | "installation.new_permissions_accepted"
        | "installation.suspend"
        | "installation.unsuspend"
        | "installation_repositories"
        | "installation_repositories.added"
        | "installation_repositories.removed"
        | "installation_target"
        | "installation_target.renamed"
        | "issue_comment"
        | "issue_comment.created"
        | "issue_comment.deleted"
        | "issue_comment.edited"
        | "issues"
        | "issues.assigned"
        | "issues.closed"
        | "issues.deleted"
        | "issues.demilestoned"
        | "issues.edited"
        | "issues.labeled"
        | "issues.locked"
        | "issues.milestoned"
        | "issues.opened"
        | "issues.pinned"
        | "issues.reopened"
        | "issues.transferred"
        | "issues.unassigned"
        | "issues.unlabeled"
        | "issues.unlocked"
        | "issues.unpinned"
        | "label"
        | "label.created"
        | "label.deleted"
        | "label.edited"
        | "marketplace_purchase"
        | "marketplace_purchase.cancelled"
        | "marketplace_purchase.changed"
        | "marketplace_purchase.pending_change"
        | "marketplace_purchase.pending_change_cancelled"
        | "marketplace_purchase.purchased"
        | "member"
        | "member.added"
        | "member.edited"
        | "member.removed"
        | "membership"
        | "membership.added"
        | "membership.removed"
        | "merge_group"
        | "merge_group.checks_requested"
        | "meta"
        | "meta.deleted"
        | "milestone"
        | "milestone.closed"
        | "milestone.created"
        | "milestone.deleted"
        | "milestone.edited"
        | "milestone.opened"
        | "org_block"
        | "org_block.blocked"
        | "org_block.unblocked"
        | "organization"
        | "organization.deleted"
        | "organization.member_added"
        | "organization.member_invited"
        | "organization.member_removed"
        | "organization.renamed"
        | "package"
        | "package.published"
        | "package.updated"
        | "page_build"
        | "ping"
        | "project"
        | "project.closed"
        | "project.created"
        | "project.deleted"
        | "project.edited"
        | "project.reopened"
        | "project_card"
        | "project_card.converted"
        | "project_card.created"
        | "project_card.deleted"
        | "project_card.edited"
        | "project_card.moved"
        | "project_column"
        | "project_column.created"
        | "project_column.deleted"
        | "project_column.edited"
        | "project_column.moved"
        | "projects_v2_item"
        | "projects_v2_item.archived"
        | "projects_v2_item.converted"
        | "projects_v2_item.created"
        | "projects_v2_item.deleted"
        | "projects_v2_item.edited"
        | "projects_v2_item.reordered"
        | "projects_v2_item.restored"
        | "public"
        | "pull_request"
        | "pull_request.assigned"
        | "pull_request.auto_merge_disabled"
        | "pull_request.auto_merge_enabled"
        | "pull_request.closed"
        | "pull_request.converted_to_draft"
        | "pull_request.demilestoned"
        | "pull_request.dequeued"
        | "pull_request.edited"
        | "pull_request.enqueued"
        | "pull_request.labeled"
        | "pull_request.locked"
        | "pull_request.milestoned"
        | "pull_request.opened"
        | "pull_request.ready_for_review"
        | "pull_request.reopened"
        | "pull_request.review_request_removed"
        | "pull_request.review_requested"
        | "pull_request.synchronize"
        | "pull_request.unassigned"
        | "pull_request.unlabeled"
        | "pull_request.unlocked"
        | "pull_request_review"
        | "pull_request_review.dismissed"
        | "pull_request_review.edited"
        | "pull_request_review.submitted"
        | "pull_request_review_comment"
        | "pull_request_review_comment.created"
        | "pull_request_review_comment.deleted"
        | "pull_request_review_comment.edited"
        | "pull_request_review_thread"
        | "pull_request_review_thread.resolved"
        | "pull_request_review_thread.unresolved"
        | "push"
        | "registry_package"
        | "registry_package.published"
        | "registry_package.updated"
        | "release"
        | "release.created"
        | "release.deleted"
        | "release.edited"
        | "release.prereleased"
        | "release.published"
        | "release.released"
        | "release.unpublished"
        | "repository"
        | "repository.archived"
        | "repository.created"
        | "repository.deleted"
        | "repository.edited"
        | "repository.privatized"
        | "repository.publicized"
        | "repository.renamed"
        | "repository.transferred"
        | "repository.unarchived"
        | "repository_dispatch"
        | "repository_import"
        | "repository_vulnerability_alert"
        | "repository_vulnerability_alert.create"
        | "repository_vulnerability_alert.dismiss"
        | "repository_vulnerability_alert.reopen"
        | "repository_vulnerability_alert.resolve"
        | "secret_scanning_alert"
        | "secret_scanning_alert.created"
        | "secret_scanning_alert.reopened"
        | "secret_scanning_alert.resolved"
        | "secret_scanning_alert.revoked"
        | "secret_scanning_alert_location"
        | "secret_scanning_alert_location.created"
        | "security_advisory"
        | "security_advisory.performed"
        | "security_advisory.published"
        | "security_advisory.updated"
        | "security_advisory.withdrawn"
        | "sponsorship"
        | "sponsorship.cancelled"
        | "sponsorship.created"
        | "sponsorship.edited"
        | "sponsorship.pending_cancellation"
        | "sponsorship.pending_tier_change"
        | "sponsorship.tier_changed"
        | "star"
        | "star.created"
        | "star.deleted"
        | "team"
        | "team.added_to_repository"
        | "team.created"
        | "team.deleted"
        | "team.edited"
        | "team.removed_from_repository"
        | "team_add"
        | "watch"
        | "watch.started"
        | "workflow_dispatch"
        | "workflow_job"
        | "workflow_job.completed"
        | "workflow_job.in_progress"
        | "workflow_job.queued"
        | "workflow_job.waiting"
        | "workflow_run"
        | "workflow_run.completed"
        | "workflow_run.in_progress"
        | "workflow_run.requested">>

  • Probot's transform option, which extends the event object that is passed to webhook event handlers by @octokit/webhooks

    Parameters

    • state: State
    • event: EmitterWebhookEvent

    Returns Promise<Context<
        | "status"
        | "branch_protection_configuration"
        | "branch_protection_rule.disabled"
        | "branch_protection_rule.enabled"
        | "branch_protection_rule"
        | "branch_protection_rule.created"
        | "branch_protection_rule.deleted"
        | "branch_protection_rule.edited"
        | "check_run"
        | "check_run.completed"
        | "check_run.created"
        | "check_run.requested_action"
        | "check_run.rerequested"
        | "check_suite"
        | "check_suite.completed"
        | "check_suite.requested"
        | "check_suite.rerequested"
        | "code_scanning_alert"
        | "code_scanning_alert.appeared_in_branch"
        | "code_scanning_alert.closed_by_user"
        | "code_scanning_alert.created"
        | "code_scanning_alert.fixed"
        | "code_scanning_alert.reopened"
        | "code_scanning_alert.reopened_by_user"
        | "commit_comment"
        | "commit_comment.created"
        | "create"
        | "custom_property"
        | "custom_property.created"
        | "custom_property.deleted"
        | "custom_property_values"
        | "custom_property_values.updated"
        | "delete"
        | "dependabot_alert"
        | "dependabot_alert.created"
        | "dependabot_alert.dismissed"
        | "dependabot_alert.fixed"
        | "dependabot_alert.reintroduced"
        | "dependabot_alert.reopened"
        | "deploy_key"
        | "deploy_key.created"
        | "deploy_key.deleted"
        | "deployment"
        | "deployment.created"
        | "deployment_protection_rule"
        | "deployment_protection_rule.requested"
        | "deployment_review"
        | "deployment_review.approved"
        | "deployment_review.rejected"
        | "deployment_review.requested"
        | "deployment_status"
        | "deployment_status.created"
        | "discussion"
        | "discussion.answered"
        | "discussion.category_changed"
        | "discussion.created"
        | "discussion.deleted"
        | "discussion.edited"
        | "discussion.labeled"
        | "discussion.locked"
        | "discussion.pinned"
        | "discussion.transferred"
        | "discussion.unanswered"
        | "discussion.unlabeled"
        | "discussion.unlocked"
        | "discussion.unpinned"
        | "discussion_comment"
        | "discussion_comment.created"
        | "discussion_comment.deleted"
        | "discussion_comment.edited"
        | "fork"
        | "github_app_authorization"
        | "github_app_authorization.revoked"
        | "gollum"
        | "installation"
        | "installation.created"
        | "installation.deleted"
        | "installation.new_permissions_accepted"
        | "installation.suspend"
        | "installation.unsuspend"
        | "installation_repositories"
        | "installation_repositories.added"
        | "installation_repositories.removed"
        | "installation_target"
        | "installation_target.renamed"
        | "issue_comment"
        | "issue_comment.created"
        | "issue_comment.deleted"
        | "issue_comment.edited"
        | "issues"
        | "issues.assigned"
        | "issues.closed"
        | "issues.deleted"
        | "issues.demilestoned"
        | "issues.edited"
        | "issues.labeled"
        | "issues.locked"
        | "issues.milestoned"
        | "issues.opened"
        | "issues.pinned"
        | "issues.reopened"
        | "issues.transferred"
        | "issues.unassigned"
        | "issues.unlabeled"
        | "issues.unlocked"
        | "issues.unpinned"
        | "label"
        | "label.created"
        | "label.deleted"
        | "label.edited"
        | "marketplace_purchase"
        | "marketplace_purchase.cancelled"
        | "marketplace_purchase.changed"
        | "marketplace_purchase.pending_change"
        | "marketplace_purchase.pending_change_cancelled"
        | "marketplace_purchase.purchased"
        | "member"
        | "member.added"
        | "member.edited"
        | "member.removed"
        | "membership"
        | "membership.added"
        | "membership.removed"
        | "merge_group"
        | "merge_group.checks_requested"
        | "meta"
        | "meta.deleted"
        | "milestone"
        | "milestone.closed"
        | "milestone.created"
        | "milestone.deleted"
        | "milestone.edited"
        | "milestone.opened"
        | "org_block"
        | "org_block.blocked"
        | "org_block.unblocked"
        | "organization"
        | "organization.deleted"
        | "organization.member_added"
        | "organization.member_invited"
        | "organization.member_removed"
        | "organization.renamed"
        | "package"
        | "package.published"
        | "package.updated"
        | "page_build"
        | "ping"
        | "project"
        | "project.closed"
        | "project.created"
        | "project.deleted"
        | "project.edited"
        | "project.reopened"
        | "project_card"
        | "project_card.converted"
        | "project_card.created"
        | "project_card.deleted"
        | "project_card.edited"
        | "project_card.moved"
        | "project_column"
        | "project_column.created"
        | "project_column.deleted"
        | "project_column.edited"
        | "project_column.moved"
        | "projects_v2_item"
        | "projects_v2_item.archived"
        | "projects_v2_item.converted"
        | "projects_v2_item.created"
        | "projects_v2_item.deleted"
        | "projects_v2_item.edited"
        | "projects_v2_item.reordered"
        | "projects_v2_item.restored"
        | "public"
        | "pull_request"
        | "pull_request.assigned"
        | "pull_request.auto_merge_disabled"
        | "pull_request.auto_merge_enabled"
        | "pull_request.closed"
        | "pull_request.converted_to_draft"
        | "pull_request.demilestoned"
        | "pull_request.dequeued"
        | "pull_request.edited"
        | "pull_request.enqueued"
        | "pull_request.labeled"
        | "pull_request.locked"
        | "pull_request.milestoned"
        | "pull_request.opened"
        | "pull_request.ready_for_review"
        | "pull_request.reopened"
        | "pull_request.review_request_removed"
        | "pull_request.review_requested"
        | "pull_request.synchronize"
        | "pull_request.unassigned"
        | "pull_request.unlabeled"
        | "pull_request.unlocked"
        | "pull_request_review"
        | "pull_request_review.dismissed"
        | "pull_request_review.edited"
        | "pull_request_review.submitted"
        | "pull_request_review_comment"
        | "pull_request_review_comment.created"
        | "pull_request_review_comment.deleted"
        | "pull_request_review_comment.edited"
        | "pull_request_review_thread"
        | "pull_request_review_thread.resolved"
        | "pull_request_review_thread.unresolved"
        | "push"
        | "registry_package"
        | "registry_package.published"
        | "registry_package.updated"
        | "release"
        | "release.created"
        | "release.deleted"
        | "release.edited"
        | "release.prereleased"
        | "release.published"
        | "release.released"
        | "release.unpublished"
        | "repository"
        | "repository.archived"
        | "repository.created"
        | "repository.deleted"
        | "repository.edited"
        | "repository.privatized"
        | "repository.publicized"
        | "repository.renamed"
        | "repository.transferred"
        | "repository.unarchived"
        | "repository_dispatch"
        | "repository_import"
        | "repository_vulnerability_alert"
        | "repository_vulnerability_alert.create"
        | "repository_vulnerability_alert.dismiss"
        | "repository_vulnerability_alert.reopen"
        | "repository_vulnerability_alert.resolve"
        | "secret_scanning_alert"
        | "secret_scanning_alert.created"
        | "secret_scanning_alert.reopened"
        | "secret_scanning_alert.resolved"
        | "secret_scanning_alert.revoked"
        | "secret_scanning_alert_location"
        | "secret_scanning_alert_location.created"
        | "security_advisory"
        | "security_advisory.performed"
        | "security_advisory.published"
        | "security_advisory.updated"
        | "security_advisory.withdrawn"
        | "sponsorship"
        | "sponsorship.cancelled"
        | "sponsorship.created"
        | "sponsorship.edited"
        | "sponsorship.pending_cancellation"
        | "sponsorship.pending_tier_change"
        | "sponsorship.tier_changed"
        | "star"
        | "star.created"
        | "star.deleted"
        | "team"
        | "team.added_to_repository"
        | "team.created"
        | "team.deleted"
        | "team.edited"
        | "team.removed_from_repository"
        | "team_add"
        | "watch"
        | "watch.started"
        | "workflow_dispatch"
        | "workflow_job"
        | "workflow_job.completed"
        | "workflow_job.in_progress"
        | "workflow_job.queued"
        | "workflow_job.waiting"
        | "workflow_run"
        | "workflow_run.completed"
        | "workflow_run.in_progress"
        | "workflow_run.requested">>

    See

    https://github.com/octokit/webhooks.js/#constructor

    -

Settings

Member Visibility
diff --git a/api/13.3.6/functions/run.run.html b/api/13.3.6/functions/run.run.html index 3fcd2621f10..4659c8476c2 100644 --- a/api/13.3.6/functions/run.run.html +++ b/api/13.3.6/functions/run.run.html @@ -1,5 +1,5 @@ run | probot

Function run

  • run(appFnOrArgv, additionalOptions?): Promise<Server>

  • Parameters

    • appFnOrArgv: string[] | ApplicationFunction

      set to either a probot application function: (app) => { ... } or to process.argv

      -
    • OptionaladditionalOptions: AdditionalOptions

    Returns Promise<Server>

Settings

Member Visibility
diff --git a/api/13.3.6/functions/server_logging_middleware.getLoggingMiddleware.html b/api/13.3.6/functions/server_logging_middleware.getLoggingMiddleware.html index 06885b93df8..d3d3e82cfef 100644 --- a/api/13.3.6/functions/server_logging_middleware.getLoggingMiddleware.html +++ b/api/13.3.6/functions/server_logging_middleware.getLoggingMiddleware.html @@ -1,4 +1,4 @@ -getLoggingMiddleware | probot

Function getLoggingMiddleware

  • getLoggingMiddleware(logger, options?): HttpLogger

  • Parameters

    • logger: Logger
    • Optionaloptions: Options<IncomingMessage, ServerResponse<IncomingMessage>, never>

    Returns HttpLogger

Settings

Member Visibility

Function getLoggingMiddleware

  • getLoggingMiddleware(logger, options?): HttpLogger

  • Parameters

    • logger: Logger
    • Optionaloptions: Options<IncomingMessage, ServerResponse<IncomingMessage>, never>

    Returns HttpLogger

Settings

Member Visibility
diff --git a/api/13.3.6/functions/views_import.importView.html b/api/13.3.6/functions/views_import.importView.html index d6ee6daaa63..66d5e3c10e9 100644 --- a/api/13.3.6/functions/views_import.importView.html +++ b/api/13.3.6/functions/views_import.importView.html @@ -1,4 +1,4 @@ -importView | probot

Function importView

  • importView(__namedParameters): string

  • Parameters

    • __namedParameters: {
          GH_HOST: string;
          WEBHOOK_PROXY_URL?: string;
          name?: string;
      }
      • GH_HOST: string
      • OptionalWEBHOOK_PROXY_URL?: string
      • Optionalname?: string

    Returns string

Settings

Member Visibility

Function importView

  • importView(__namedParameters): string

  • Parameters

    • __namedParameters: {
          GH_HOST: string;
          WEBHOOK_PROXY_URL?: string;
          name?: string;
      }
      • GH_HOST: string
      • OptionalWEBHOOK_PROXY_URL?: string
      • Optionalname?: string

    Returns string

Settings

Member Visibility
diff --git a/api/13.3.6/functions/views_probot.probotView.html b/api/13.3.6/functions/views_probot.probotView.html index 5ed984541d0..c61e59c7c2b 100644 --- a/api/13.3.6/functions/views_probot.probotView.html +++ b/api/13.3.6/functions/views_probot.probotView.html @@ -1,4 +1,4 @@ -probotView | probot

Function probotView

  • probotView(__namedParameters): string

  • Parameters

    • __namedParameters: {
          description?: string;
          name?: string;
          version?: string;
      }
      • Optionaldescription?: string
      • Optionalname?: string
      • Optionalversion?: string

    Returns string

Settings

Member Visibility

Function probotView

  • probotView(__namedParameters): string

  • Parameters

    • __namedParameters: {
          description?: string;
          name?: string;
          version?: string;
      }
      • Optionaldescription?: string
      • Optionalname?: string
      • Optionalversion?: string

    Returns string

Settings

Member Visibility
diff --git a/api/13.3.6/functions/views_setup.setupView.html b/api/13.3.6/functions/views_setup.setupView.html index 56eebafeffb..b2fb4c08cb7 100644 --- a/api/13.3.6/functions/views_setup.setupView.html +++ b/api/13.3.6/functions/views_setup.setupView.html @@ -1,4 +1,4 @@ -setupView | probot

Function setupView

  • setupView(__namedParameters): string

  • Parameters

    • __namedParameters: {
          createAppUrl: string;
          description?: string;
          manifest: string;
          name?: string;
          version?: string;
      }
      • createAppUrl: string
      • Optionaldescription?: string
      • manifest: string
      • Optionalname?: string
      • Optionalversion?: string

    Returns string

Settings

Member Visibility

Function setupView

  • setupView(__namedParameters): string

  • Parameters

    • __namedParameters: {
          createAppUrl: string;
          description?: string;
          manifest: string;
          name?: string;
          version?: string;
      }
      • createAppUrl: string
      • Optionaldescription?: string
      • manifest: string
      • Optionalname?: string
      • Optionalversion?: string

    Returns string

Settings

Member Visibility
diff --git a/api/13.3.6/functions/views_success.successView.html b/api/13.3.6/functions/views_success.successView.html index 77092ffa61c..6fb2b05d2d6 100644 --- a/api/13.3.6/functions/views_success.successView.html +++ b/api/13.3.6/functions/views_success.successView.html @@ -1,4 +1,4 @@ -successView | probot

Function successView

  • successView(__namedParameters): string

  • Parameters

    • __namedParameters: {
          name?: string;
      }
      • Optionalname?: string

    Returns string

Settings

Member Visibility

Function successView

  • successView(__namedParameters): string

  • Parameters

    • __namedParameters: {
          name?: string;
      }
      • Optionalname?: string

    Returns string

Settings

Member Visibility
diff --git a/api/13.3.6/interfaces/helpers_resolve_app_function.ResolveOptions.html b/api/13.3.6/interfaces/helpers_resolve_app_function.ResolveOptions.html index 1df869df713..e59a4eeeb41 100644 --- a/api/13.3.6/interfaces/helpers_resolve_app_function.ResolveOptions.html +++ b/api/13.3.6/interfaces/helpers_resolve_app_function.ResolveOptions.html @@ -1,6 +1,6 @@ -ResolveOptions | probot

Interface ResolveOptions

interface ResolveOptions {
    basedir?: string;
    resolver?: RequireResolve;
}

Properties

basedir? +ResolveOptions | probot

Interface ResolveOptions

interface ResolveOptions {
    basedir?: string;
    resolver?: RequireResolve;
}

Properties

basedir? resolver? -

Properties

Optionalbasedir

basedir?: string

Optionalresolver

resolver?: RequireResolve

Settings

Member Visibility

On This Page

Properties
diff --git a/api/13.3.6/interfaces/helpers_webhook_proxy.WebhookProxyOptions.html b/api/13.3.6/interfaces/helpers_webhook_proxy.WebhookProxyOptions.html index d87a01ee8e0..f53e9d5cfe6 100644 --- a/api/13.3.6/interfaces/helpers_webhook_proxy.WebhookProxyOptions.html +++ b/api/13.3.6/interfaces/helpers_webhook_proxy.WebhookProxyOptions.html @@ -1,9 +1,9 @@ -WebhookProxyOptions | probot

Interface WebhookProxyOptions

interface WebhookProxyOptions {
    fetch?: Function;
    logger: Logger;
    path?: string;
    port?: number;
    url: string;
}

Properties

fetch? +WebhookProxyOptions | probot

Interface WebhookProxyOptions

interface WebhookProxyOptions {
    fetch?: Function;
    logger: Logger;
    path?: string;
    port?: number;
    url: string;
}

Properties

fetch? logger path? port? url -

Properties

Optionalfetch

fetch?: Function

logger

logger: Logger

Optionalpath

path?: string

Optionalport

port?: number

url

url: string

Settings

Member Visibility

On This Page

Properties
diff --git a/api/13.3.6/interfaces/types.Options.html b/api/13.3.6/interfaces/types.Options.html index aa86dd83004..1bb5f3a6723 100644 --- a/api/13.3.6/interfaces/types.Options.html +++ b/api/13.3.6/interfaces/types.Options.html @@ -1,4 +1,4 @@ -Options | probot

Interface Options

interface Options {
    Octokit?: typeof Octokit & Constructor<{} & {} & RestEndpointMethods & Api & API>;
    appId?: string | number;
    baseUrl?: string;
    githubToken?: string;
    host?: string;
    log?: Logger;
    logLevel?:
        | "fatal"
        | "error"
        | "warn"
        | "info"
        | "debug"
        | "trace";
    logMessageKey?: string;
    port?: number;
    privateKey?: string;
    redisConfig?: string | RedisOptions;
    request?: RequestRequestOptions;
    secret?: string;
    webhookPath?: string;
}

Properties

Octokit? +Options | probot

Interface Options

interface Options {
    Octokit?: typeof Octokit & Constructor<{} & {} & RestEndpointMethods & Api & API>;
    appId?: string | number;
    baseUrl?: string;
    githubToken?: string;
    host?: string;
    log?: Logger;
    logLevel?:
        | "fatal"
        | "error"
        | "warn"
        | "info"
        | "debug"
        | "trace";
    logMessageKey?: string;
    port?: number;
    privateKey?: string;
    redisConfig?: string | RedisOptions;
    request?: RequestRequestOptions;
    secret?: string;
    webhookPath?: string;
}

Properties

Octokit? appId? baseUrl? githubToken? @@ -12,7 +12,7 @@ request? secret? webhookPath? -

Properties

OptionalOctokit

Octokit?: typeof Octokit & Constructor<{} & {} & RestEndpointMethods & Api & API>

OptionalappId

appId?: string | number

OptionalbaseUrl

baseUrl?: string

OptionalgithubToken

githubToken?: string

Optionalhost

host?: string

Optionallog

log?: Logger

OptionallogLevel

logLevel?:
    | "fatal"
    | "error"
    | "warn"
    | "info"
    | "debug"
    | "trace"

OptionallogMessageKey

logMessageKey?: string

Optionalport

port?: number

OptionalprivateKey

privateKey?: string

OptionalredisConfig

redisConfig?: string | RedisOptions

Optionalrequest

request?: RequestRequestOptions

Optionalsecret

secret?: string

OptionalwebhookPath

webhookPath?: string

Settings

Member Visibility

On This Page

Properties
diff --git a/api/13.3.6/modules/apps_default.html b/api/13.3.6/modules/apps_default.html index c1ec4cca5c0..7907e25ae8a 100644 --- a/api/13.3.6/modules/apps_default.html +++ b/api/13.3.6/modules/apps_default.html @@ -1,4 +1,4 @@ -apps/default | probot

Module apps/default

Index

Functions

defaultApp +apps/default | probot

Module apps/default

Index

Functions

defaultApp

Settings

Member Visibility

Module apps/setup

Index

Functions

setupAppFactory +apps/setup | probot

Module apps/setup

Index

Functions

setupAppFactory

Settings

Member Visibility

Module auth

Index

Functions

auth +auth | probot

Module auth

Index

Functions

auth

Settings

Member Visibility

Module bin/probot

Settings

Member Visibility

Module bin/probot

Settings

Member Visibility
diff --git a/api/13.3.6/modules/bin_probot_receive.html b/api/13.3.6/modules/bin_probot_receive.html index 00627ffb139..58cbd7dcdad 100644 --- a/api/13.3.6/modules/bin_probot_receive.html +++ b/api/13.3.6/modules/bin_probot_receive.html @@ -1,4 +1,4 @@ -bin/probot-receive | probot

Module bin/probot-receive

Settings

Member Visibility

Module bin/probot-receive

Settings

Member Visibility
diff --git a/api/13.3.6/modules/bin_probot_run.html b/api/13.3.6/modules/bin_probot_run.html index 3e83565cfd0..8b84e3c725e 100644 --- a/api/13.3.6/modules/bin_probot_run.html +++ b/api/13.3.6/modules/bin_probot_run.html @@ -1,4 +1,4 @@ -bin/probot-run | probot

Module bin/probot-run

Settings

Member Visibility

Module bin/probot-run

Settings

Member Visibility
diff --git a/api/13.3.6/modules/bin_read_cli_options.html b/api/13.3.6/modules/bin_read_cli_options.html index ca0430a1230..5c97f6449e2 100644 --- a/api/13.3.6/modules/bin_read_cli_options.html +++ b/api/13.3.6/modules/bin_read_cli_options.html @@ -1,4 +1,4 @@ -bin/read-cli-options | probot

Module bin/read-cli-options

Index

Functions

readCliOptions +bin/read-cli-options | probot

Module bin/read-cli-options

Index

Functions

readCliOptions

Settings

Member Visibility

Module bin/read-env-options

Index

Functions

readEnvOptions +bin/read-env-options | probot

Module bin/read-env-options

Index

Functions

readEnvOptions

Settings

Member Visibility

Module context

Index

Classes

Context +context | probot

Module context

Index

Classes

Context

Type Aliases

MergeOptions

Settings

Member Visibility

Module create-node-middleware

Index

Functions

createNodeMiddleware +create-node-middleware | probot

Module create-node-middleware

Index

Functions

createNodeMiddleware

Settings

Member Visibility

Module create-probot

Index

Functions

createProbot +create-probot | probot

Module create-probot

Index

Functions

createProbot

Settings

Member Visibility

Module get-router

Index

Functions

getRouter +get-router | probot

Module get-router

Index

Functions

getRouter

Settings

Member Visibility

Module helpers/get-error-handler

Index

Functions

getErrorHandler +helpers/get-error-handler | probot

Module helpers/get-error-handler

Index

Functions

getErrorHandler

Settings

Member Visibility

Module helpers/get-log

Index

Type Aliases

GetLogOptions +helpers/get-log | probot

Module helpers/get-log

Index

Type Aliases

GetLogOptions

Functions

getLog

Settings

Member Visibility

Module helpers/is-production

Index

Functions

isProduction +helpers/is-production | probot

Module helpers/is-production

Index

Functions

isProduction

Settings

Member Visibility

Module helpers/is-supported-node-version

Index

Functions

isSupportedNodeVersion +helpers/is-supported-node-version | probot

Module helpers/is-supported-node-version

Index

Functions

isSupportedNodeVersion

Settings

Member Visibility

Module helpers/load-package-json

Index

Functions

loadPackageJson +helpers/load-package-json | probot

Module helpers/load-package-json

Index

Functions

loadPackageJson

Settings

Member Visibility

Module helpers/rebind-log

Index

Functions

rebindLog +helpers/rebind-log | probot

Module helpers/rebind-log

Index

Functions

rebindLog

Settings

Member Visibility

Module helpers/resolve-app-function

Index

Interfaces

ResolveOptions +helpers/resolve-app-function | probot

Module helpers/resolve-app-function

Index

Interfaces

ResolveOptions

Functions

resolveAppFunction

Settings

Member Visibility

Module helpers/webhook-proxy

Index

Interfaces

WebhookProxyOptions +helpers/webhook-proxy | probot

Module helpers/webhook-proxy

Index

Interfaces

WebhookProxyOptions

Functions

createWebhookProxy

Settings

Member Visibility

Module index

References

ApplicationFunction +index | probot

Module index

References

ApplicationFunction ApplicationFunctionOptions Context Options diff --git a/api/13.3.6/modules/manifest_creation.html b/api/13.3.6/modules/manifest_creation.html index f4d794e15b0..e4345b7c254 100644 --- a/api/13.3.6/modules/manifest_creation.html +++ b/api/13.3.6/modules/manifest_creation.html @@ -1,4 +1,4 @@ -manifest-creation | probot

Module manifest-creation

Index

Classes

ManifestCreation +manifest-creation | probot

Module manifest-creation

Index

Classes

ManifestCreation

Settings

Member Visibility

Module octokit/get-authenticated-octokit

Index

Functions

getAuthenticatedOctokit +octokit/get-authenticated-octokit | probot

Module octokit/get-authenticated-octokit

Index

Functions

getAuthenticatedOctokit

Settings

Member Visibility

Module octokit/get-octokit-throttle-options

Index

Functions

getOctokitThrottleOptions +octokit/get-octokit-throttle-options | probot

Module octokit/get-octokit-throttle-options

Index

Functions

getOctokitThrottleOptions

Settings

Member Visibility

Module octokit/get-probot-octokit-with-defaults

Index

Functions

getProbotOctokitWithDefaults +octokit/get-probot-octokit-with-defaults | probot

Module octokit/get-probot-octokit-with-defaults

Index

Functions

getProbotOctokitWithDefaults

Settings

Member Visibility

Module octokit/get-webhooks

Index

Functions

getWebhooks +octokit/get-webhooks | probot

Module octokit/get-webhooks

Index

Functions

getWebhooks

Settings

Member Visibility

Module octokit/octokit-plugin-probot-request-logging

Index

Functions

probotRequestLogging +octokit/octokit-plugin-probot-request-logging | probot

Module octokit/octokit-plugin-probot-request-logging

Index

Functions

probotRequestLogging

Settings

Member Visibility

Module octokit/octokit-webhooks-transform

Index

Functions

webhookTransform +octokit/octokit-webhooks-transform | probot

Module octokit/octokit-webhooks-transform

Index

Functions

webhookTransform

Settings

Member Visibility

Module octokit/probot-octokit

Index

Type Aliases

ProbotOctokit +octokit/probot-octokit | probot

Module octokit/probot-octokit

Index

Type Aliases

ProbotOctokit

Variables

ProbotOctokit

Settings

Member Visibility

Module probot

Index

Classes

Probot +probot | probot

Module probot

Index

Classes

Probot

Type Aliases

Constructor

Settings

Member Visibility

Module run

Index

Functions

run +run | probot

Module run

Index

Functions

run

Settings

Member Visibility

Module server/logging-middleware

Index

Functions

getLoggingMiddleware +server/logging-middleware | probot

Module server/logging-middleware

Index

Functions

getLoggingMiddleware

Settings

Member Visibility

Module server/server

Index

Classes

Server +server/server | probot

Module server/server

Index

Classes

Server

Variables

defaultWebhooksPath

Settings

Member Visibility

Module types

Index

Interfaces

Options +types | probot

Module types

Index

Interfaces

Options

Type Aliases

ApplicationFunction ApplicationFunctionOptions Env diff --git a/api/13.3.6/modules/version.html b/api/13.3.6/modules/version.html index d412287b600..ea12dcef64c 100644 --- a/api/13.3.6/modules/version.html +++ b/api/13.3.6/modules/version.html @@ -1,4 +1,4 @@ -version | probot

Module version

Index

Variables

VERSION +version | probot

Module version

Index

Variables

VERSION

Settings

Member Visibility

Module views/import

Index

Functions

importView +views/import | probot

Module views/import

Index

Functions

importView

Settings

Member Visibility

Module views/probot

Index

Functions

probotView +views/probot | probot

Module views/probot

Index

Functions

probotView

Settings

Member Visibility

Module views/setup

Index

Functions

setupView +views/setup | probot

Module views/setup

Index

Functions

setupView

Settings

Member Visibility

Module views/success

Index

Functions

successView +views/success | probot

Module views/success

Index

Functions

successView

Settings

Member Visibility

Type Alias MergeOptions

MergeOptions: merge.Options

Settings

Member Visibility

Type Alias MergeOptions

MergeOptions: merge.Options

Settings

Member Visibility
diff --git a/api/13.3.6/types/helpers_get_log.GetLogOptions.html b/api/13.3.6/types/helpers_get_log.GetLogOptions.html index 0d17b5af5b7..50a9fe0a5b8 100644 --- a/api/13.3.6/types/helpers_get_log.GetLogOptions.html +++ b/api/13.3.6/types/helpers_get_log.GetLogOptions.html @@ -1,4 +1,4 @@ -GetLogOptions | probot

Type Alias GetLogOptions

GetLogOptions: {
    level?: LogLevel;
    logMessageKey?: string;
} & Options

Settings

Member Visibility

Type Alias GetLogOptions

GetLogOptions: {
    level?: LogLevel;
    logMessageKey?: string;
} & Options

Settings

Member Visibility
diff --git a/api/13.3.6/types/octokit_probot_octokit.ProbotOctokit.html b/api/13.3.6/types/octokit_probot_octokit.ProbotOctokit.html index 7cfc8662e70..6828d0a85c8 100644 --- a/api/13.3.6/types/octokit_probot_octokit.ProbotOctokit.html +++ b/api/13.3.6/types/octokit_probot_octokit.ProbotOctokit.html @@ -1,4 +1,4 @@ -ProbotOctokit | probot

Type Alias ProbotOctokit

ProbotOctokit: InstanceType<typeof ProbotOctokit>

Settings

Member Visibility

Type Alias ProbotOctokit

ProbotOctokit: InstanceType<typeof ProbotOctokit>

Settings

Member Visibility
diff --git a/api/13.3.6/types/probot.Constructor.html b/api/13.3.6/types/probot.Constructor.html index 6a3a1f30a6b..ce38305410a 100644 --- a/api/13.3.6/types/probot.Constructor.html +++ b/api/13.3.6/types/probot.Constructor.html @@ -1,4 +1,4 @@ -Constructor | probot

Type Alias Constructor<T>

Constructor<T>: (new (...args: any[]) => T)

Type Parameters

  • T = any

Settings

Member Visibility

Type Alias Constructor<T>

Constructor<T>: (new (...args: any[]) => T)

Type Parameters

  • T = any

Settings

Member Visibility
diff --git a/api/13.3.6/types/types.ApplicationFunction.html b/api/13.3.6/types/types.ApplicationFunction.html index b9404aaa4d0..c712f798f4a 100644 --- a/api/13.3.6/types/types.ApplicationFunction.html +++ b/api/13.3.6/types/types.ApplicationFunction.html @@ -1,4 +1,4 @@ -ApplicationFunction | probot

Type Alias ApplicationFunction

ApplicationFunction: ((app: Probot, options: ApplicationFunctionOptions) => void | Promise<void>)

Settings

Member Visibility

Type Alias ApplicationFunction

ApplicationFunction: ((app: Probot, options: ApplicationFunctionOptions) => void | Promise<void>)

Settings

Member Visibility
diff --git a/api/13.3.6/types/types.ApplicationFunctionOptions.html b/api/13.3.6/types/types.ApplicationFunctionOptions.html index e10cc950c6a..42d00a88b2e 100644 --- a/api/13.3.6/types/types.ApplicationFunctionOptions.html +++ b/api/13.3.6/types/types.ApplicationFunctionOptions.html @@ -1,4 +1,4 @@ -ApplicationFunctionOptions | probot

Type Alias ApplicationFunctionOptions

ApplicationFunctionOptions: {
    cwd?: string;
    getRouter?: ((path?: string) => express.Router);
    [key: string]: unknown;
}

Settings

Member Visibility

Type Alias ApplicationFunctionOptions

ApplicationFunctionOptions: {
    cwd?: string;
    getRouter?: ((path?: string) => express.Router);
    [key: string]: unknown;
}

Settings

Member Visibility
diff --git a/api/13.3.6/types/types.Env.html b/api/13.3.6/types/types.Env.html index 6e18a606838..f3245af5145 100644 --- a/api/13.3.6/types/types.Env.html +++ b/api/13.3.6/types/types.Env.html @@ -1,4 +1,4 @@ -Env | probot

Type Alias Env

Env: Record<Uppercase<string>, string>

Settings

Member Visibility

Type Alias Env

Env: Record<Uppercase<string>, string>

Settings

Member Visibility
diff --git a/api/13.3.6/types/types.Manifest.html b/api/13.3.6/types/types.Manifest.html index 55868d694d6..69abdc454d5 100644 --- a/api/13.3.6/types/types.Manifest.html +++ b/api/13.3.6/types/types.Manifest.html @@ -10,7 +10,7 @@
  • Optionalsetup_on_update?: boolean

    Set to true to redirect users to the setup_url after they update your GitHub App installation.

  • Optionalsetup_url?: string

    A full URL to redirect users to after they install your GitHub App if additional setup is required.

  • url: string

    Required. The homepage of your GitHub App.

    -

    • Settings

    Member Visibility
    diff --git a/api/13.3.6/types/types.MiddlewareOptions.html b/api/13.3.6/types/types.MiddlewareOptions.html index 6d8ed9b5579..4ce4c7c59e0 100644 --- a/api/13.3.6/types/types.MiddlewareOptions.html +++ b/api/13.3.6/types/types.MiddlewareOptions.html @@ -1,4 +1,4 @@ -MiddlewareOptions | probot

    Type Alias MiddlewareOptions

    MiddlewareOptions: {
        probot: Probot;
        webhooksPath?: string;
        [key: string]: unknown;
    }

    Settings

    Member Visibility

    Type Alias MiddlewareOptions

    MiddlewareOptions: {
        probot: Probot;
        webhooksPath?: string;
        [key: string]: unknown;
    }

    Settings

    Member Visibility
    diff --git a/api/13.3.6/types/types.OctokitOptions.html b/api/13.3.6/types/types.OctokitOptions.html index 6d880b3d3e4..e1917d4a2ae 100644 --- a/api/13.3.6/types/types.OctokitOptions.html +++ b/api/13.3.6/types/types.OctokitOptions.html @@ -1,4 +1,4 @@ -OctokitOptions | probot

    Type Alias OctokitOptions

    OctokitOptions: NonNullable<ConstructorParameters<typeof ProbotOctokit>[0]>

    Settings

    Member Visibility

    Type Alias OctokitOptions

    OctokitOptions: NonNullable<ConstructorParameters<typeof ProbotOctokit>[0]>

    Settings

    Member Visibility
    diff --git a/api/13.3.6/types/types.PackageJson.html b/api/13.3.6/types/types.PackageJson.html index 6077964898f..5100835ce8e 100644 --- a/api/13.3.6/types/types.PackageJson.html +++ b/api/13.3.6/types/types.PackageJson.html @@ -1,4 +1,4 @@ -PackageJson | probot

    Type Alias PackageJson

    PackageJson: {
        description?: string;
        engines?: {
            [key: string]: string;
        };
        homepage?: string;
        name?: string;
        repository?: string;
        version?: string;
    }

    Settings

    Member Visibility

    Type Alias PackageJson

    PackageJson: {
        description?: string;
        engines?: {
            [key: string]: string;
        };
        homepage?: string;
        name?: string;
        repository?: string;
        version?: string;
    }

    Settings

    Member Visibility
    diff --git a/api/13.3.6/types/types.ProbotWebhooks.html b/api/13.3.6/types/types.ProbotWebhooks.html index 64f25512dca..5cbe366d1c5 100644 --- a/api/13.3.6/types/types.ProbotWebhooks.html +++ b/api/13.3.6/types/types.ProbotWebhooks.html @@ -1,4 +1,4 @@ -ProbotWebhooks | probot

    Type Alias ProbotWebhooks

    ProbotWebhooks: Webhooks<SimplifiedObject>

    Settings

    Member Visibility

    Type Alias ProbotWebhooks

    ProbotWebhooks: Webhooks<SimplifiedObject>

    Settings

    Member Visibility
    diff --git a/api/13.3.6/types/types.ServerOptions.html b/api/13.3.6/types/types.ServerOptions.html index 31fe36142ec..8581e66e25f 100644 --- a/api/13.3.6/types/types.ServerOptions.html +++ b/api/13.3.6/types/types.ServerOptions.html @@ -1,4 +1,4 @@ -ServerOptions | probot

    Type Alias ServerOptions

    ServerOptions: {
        Probot: typeof Probot;
        cwd?: string;
        host?: string;
        log?: Logger;
        loggingOptions?: LoggingOptions;
        port?: number;
        request?: RequestRequestOptions;
        webhookPath?: string;
        webhookProxy?: string;
    }

    Settings

    Member Visibility

    Type Alias ServerOptions

    ServerOptions: {
        Probot: typeof Probot;
        cwd?: string;
        host?: string;
        log?: Logger;
        loggingOptions?: LoggingOptions;
        port?: number;
        request?: RequestRequestOptions;
        webhookPath?: string;
        webhookProxy?: string;
    }

    Settings

    Member Visibility
    diff --git a/api/13.3.6/types/types.State.html b/api/13.3.6/types/types.State.html index acbf7744b6e..50097d34d29 100644 --- a/api/13.3.6/types/types.State.html +++ b/api/13.3.6/types/types.State.html @@ -1,4 +1,4 @@ -State | probot

    Type Alias State

    State: {
        Octokit: typeof ProbotOctokit;
        appId?: number;
        baseUrl?: string;
        cache?: LRUCache<number, string>;
        githubToken?: string;
        host?: string;
        log: Logger;
        octokit: ProbotOctokit;
        port?: number;
        privateKey?: string;
        request?: RequestRequestOptions;
        webhookPath: string;
        webhooks: {
            secret?: string;
        };
    }

    Settings

    Member Visibility

    Type Alias State

    State: {
        Octokit: typeof ProbotOctokit;
        appId?: number;
        baseUrl?: string;
        cache?: LRUCache<number, string>;
        githubToken?: string;
        host?: string;
        log: Logger;
        octokit: ProbotOctokit;
        port?: number;
        privateKey?: string;
        request?: RequestRequestOptions;
        webhookPath: string;
        webhooks: {
            secret?: string;
        };
    }

    Settings

    Member Visibility
    diff --git a/api/13.3.6/variables/octokit_probot_octokit.ProbotOctokit-1.html b/api/13.3.6/variables/octokit_probot_octokit.ProbotOctokit-1.html index ae524c5c6d6..e97dcc1f189 100644 --- a/api/13.3.6/variables/octokit_probot_octokit.ProbotOctokit-1.html +++ b/api/13.3.6/variables/octokit_probot_octokit.ProbotOctokit-1.html @@ -1,4 +1,4 @@ -ProbotOctokit | probot

    Variable ProbotOctokitConst

    ProbotOctokit: typeof Octokit & Constructor<{} & {} & RestEndpointMethods & Api & API> = ...

    Settings

    Member Visibility

    Variable ProbotOctokitConst

    ProbotOctokit: typeof Octokit & Constructor<{} & {} & RestEndpointMethods & Api & API> = ...

    Settings

    Member Visibility
    diff --git a/api/13.3.6/variables/server_server.defaultWebhooksPath.html b/api/13.3.6/variables/server_server.defaultWebhooksPath.html index cb47078921b..d0b6c78e1e2 100644 --- a/api/13.3.6/variables/server_server.defaultWebhooksPath.html +++ b/api/13.3.6/variables/server_server.defaultWebhooksPath.html @@ -1,4 +1,4 @@ -defaultWebhooksPath | probot

    Variable defaultWebhooksPathConst

    defaultWebhooksPath: "/api/github/webhooks" = "/api/github/webhooks"

    Settings

    Member Visibility

    Variable defaultWebhooksPathConst

    defaultWebhooksPath: "/api/github/webhooks" = "/api/github/webhooks"

    Settings

    Member Visibility
    diff --git a/api/13.3.6/variables/version.VERSION.html b/api/13.3.6/variables/version.VERSION.html index 3e59ededac1..cb250fa3a69 100644 --- a/api/13.3.6/variables/version.VERSION.html +++ b/api/13.3.6/variables/version.VERSION.html @@ -1,4 +1,4 @@ -VERSION | probot

    Variable VERSIONConst

    VERSION: "0.0.0-development" = "0.0.0-development"

    Settings

    Member Visibility

    Variable VERSIONConst

    VERSION: "0.0.0-development" = "0.0.0-development"

    Settings

    Member Visibility