Module trigger.github
ballerinax/trigger.github Ballerina library
0.12.0
Overview
The GitHub Trigger module allows you to listen to following events occur in GitHub.
Ping,Fork,Push,Create,WatchRelease,Issue,Label,MilestonePull Request,Pull Request Review,Pull Request Review Comment
This module supports GitHub API v4 version and only allows to perform functions behalf of the currently logged in user.
Prerequisites
Before using this trigger in your Ballerina application, complete the following:
- Create github account
Compatibility
| Version | |
|---|---|
| Ballerina Language | Ballerina Swan Lake 2201.11.0 |
Quickstart
To use the GitHub Trigger in your Ballerina application, update the .bal file as follows:
Step 1: Import the GitHub Webhook Ballerina library
First, import the ballerinax/github.webhook and ballerina/websub modules into the Ballerina project as follows.
import ballerinax/trigger.github;
Step 2: Initialize the GitHub Webhook Listener
Initialize the Trigger by providing the listener config & port number/httpListener object.
configurable github:ListenerConfig userInput = { secret: "xxxxxx" }; listener github:Listener webhookListener = new (userInput, 8090);
Listener config is not mandatory If you haven't setup secret in webhook page we can omit it and initialize as follows.
listener github:Listener webhookListener = new (listenOn = 8090);
If you don't provide a port it will use the default port which is 8090.
listener github:Listener webhookListener = new ();
Step 3: Use the correct service type to implement the service
Use the correct service type for the corresponding channel when implementing the service. Ex :- If you need to listen to Issue events you may use IssuesService service type as follows.
service github:IssuesService on githubListener { remote function onAssigned(github:IssuesEvent payload) returns error? { return; } remote function onClosed(github:IssuesEvent payload) returns error? { return; } remote function onLabeled(github:IssuesEvent payload) returns error? { return; } remote function onOpened(github:IssuesEvent payload) returns error? { return; } remote function onReopened(github:IssuesEvent payload) returns error? { return; } remote function onUnassigned(github:IssuesEvent payload) returns error? { return; } remote function onUnlabeled(github:IssuesEvent payload) returns error? { return; } }
Step 4: Provide remote functions corresponding to the events which you are interested on
The remote functions can be provided as follows.
remote function onPush(github:PushEvent payload) returns error? { log:printInfo("Received push-event-message ", eventPayload = payload); }
Step 5: Run the service
Use bal run command to compile and run the Ballerina program.
Step 5: Configure Github webhook with the URL of the service
- Create a webhook in github following github documentation
- Provide the public URL of the started service as the Payload URL (Add a trailing / to the URL if its not present).
- Provide application/json for the content type.
- Support for secret field will be available in the next github trigger releases.
- Select the list of events you need to subscribe to and click on Add webhook.
This will add a subscription to github event api and the ballerina service functions will be triggerred once an event is fired.
Report issues
To report bugs, request new features, start new discussions, etc., go to the Ballerina Library repository
Useful links
- For more information go to the
trigger.githubpackage. - For example demonstrations of the usage, go to Ballerina By Examples.
- Chat live with us via our Discord server.
- Post all technical questions on Stack Overflow with the #ballerina tag.
Service types
trigger.github: DeleteService
onDelete
Remote Function
function onDelete(DeleteEvent payload) returns error?Parameters
- payload DeleteEvent -
trigger.github: MetaService
onMeta
Remote Function
Parameters
- payload MetaEvent -
trigger.github: WorkflowDispatchService
onWorkflowDispatch
Remote Function
function onWorkflowDispatch(WorkflowDispatchEvent payload) returns error?Parameters
- payload WorkflowDispatchEvent -
trigger.github: SecurityAndAnalysisService
onSecurityAndAnalysis
Remote Function
function onSecurityAndAnalysis(SecurityAndAnalysisEvent payload) returns error?Parameters
- payload SecurityAndAnalysisEvent -
trigger.github: DeployKeyService
onCreated
Remote Function
function onCreated(DeployKeyEvent payload) returns error?Parameters
- payload DeployKeyEvent -
onDeleted
Remote Function
function onDeleted(DeployKeyEvent payload) returns error?Parameters
- payload DeployKeyEvent -
trigger.github: ProjectColumnService
onMoved
Remote Function
function onMoved(ProjectColumnEvent payload) returns error?Parameters
- payload ProjectColumnEvent -
onEdited
Remote Function
function onEdited(ProjectColumnEvent payload) returns error?Parameters
- payload ProjectColumnEvent -
onDeleted
Remote Function
function onDeleted(ProjectColumnEvent payload) returns error?Parameters
- payload ProjectColumnEvent -
onCreated
Remote Function
function onCreated(ProjectColumnEvent payload) returns error?Parameters
- payload ProjectColumnEvent -
trigger.github: MarketplacePurchaseService
onPurchased
Remote Function
function onPurchased(MarketplacePurchaseEvent payload) returns error?Parameters
- payload MarketplacePurchaseEvent -
onCancelled
Remote Function
function onCancelled(MarketplacePurchaseEvent payload) returns error?Parameters
- payload MarketplacePurchaseEvent -
onPendingChangeCancelled
Remote Function
function onPendingChangeCancelled(MarketplacePurchaseEvent payload) returns error?Parameters
- payload MarketplacePurchaseEvent -
onPendingChange
Remote Function
function onPendingChange(MarketplacePurchaseEvent payload) returns error?Parameters
- payload MarketplacePurchaseEvent -
onChanged
Remote Function
function onChanged(MarketplacePurchaseEvent payload) returns error?Parameters
- payload MarketplacePurchaseEvent -
trigger.github: BranchProtectionConfigurationService
onEnabled
Remote Function
function onEnabled(BranchProtectionConfigurationEvent payload) returns error?Parameters
- payload BranchProtectionConfigurationEvent -
onDisabled
Remote Function
function onDisabled(BranchProtectionConfigurationEvent payload) returns error?Parameters
- payload BranchProtectionConfigurationEvent -
trigger.github: PullRequestService
onEnqueued
Remote Function
function onEnqueued(PullRequestEvent payload) returns error?Parameters
- payload PullRequestEvent -
onReviewRequestRemoved
Remote Function
function onReviewRequestRemoved(PullRequestEvent payload) returns error?Parameters
- payload PullRequestEvent -
onOpened
Remote Function
function onOpened(PullRequestEvent payload) returns error?Parameters
- payload PullRequestEvent -
onReadyForReview
Remote Function
function onReadyForReview(PullRequestEvent payload) returns error?Parameters
- payload PullRequestEvent -
onLabeled
Remote Function
function onLabeled(PullRequestEvent payload) returns error?Parameters
- payload PullRequestEvent -
onUnassigned
Remote Function
function onUnassigned(PullRequestEvent payload) returns error?Parameters
- payload PullRequestEvent -
onEdited
Remote Function
function onEdited(PullRequestEvent payload) returns error?Parameters
- payload PullRequestEvent -
onSynchronize
Remote Function
function onSynchronize(PullRequestEvent payload) returns error?Parameters
- payload PullRequestEvent -
onReviewRequested
Remote Function
function onReviewRequested(PullRequestEvent payload) returns error?Parameters
- payload PullRequestEvent -
onReopened
Remote Function
function onReopened(PullRequestEvent payload) returns error?Parameters
- payload PullRequestEvent -
onAutoMergeDisabled
Remote Function
function onAutoMergeDisabled(PullRequestEvent payload) returns error?Parameters
- payload PullRequestEvent -
onLocked
Remote Function
function onLocked(PullRequestEvent payload) returns error?Parameters
- payload PullRequestEvent -
onAutoMergeEnabled
Remote Function
function onAutoMergeEnabled(PullRequestEvent payload) returns error?Parameters
- payload PullRequestEvent -
onMilestoned
Remote Function
function onMilestoned(PullRequestEvent payload) returns error?Parameters
- payload PullRequestEvent -
onDequeued
Remote Function
function onDequeued(PullRequestEvent payload) returns error?Parameters
- payload PullRequestEvent -
onUnlabeled
Remote Function
function onUnlabeled(PullRequestEvent payload) returns error?Parameters
- payload PullRequestEvent -
onClosed
Remote Function
function onClosed(PullRequestEvent payload) returns error?Parameters
- payload PullRequestEvent -
onUnlocked
Remote Function
function onUnlocked(PullRequestEvent payload) returns error?Parameters
- payload PullRequestEvent -
onAssigned
Remote Function
function onAssigned(PullRequestEvent payload) returns error?Parameters
- payload PullRequestEvent -
onConvertedToDraft
Remote Function
function onConvertedToDraft(PullRequestEvent payload) returns error?Parameters
- payload PullRequestEvent -
onDemilestoned
Remote Function
function onDemilestoned(PullRequestEvent payload) returns error?Parameters
- payload PullRequestEvent -
trigger.github: LabelService
onEdited
Remote Function
function onEdited(LabelEvent payload) returns error?Parameters
- payload LabelEvent -
onCreated
Remote Function
function onCreated(LabelEvent payload) returns error?Parameters
- payload LabelEvent -
onDeleted
Remote Function
function onDeleted(LabelEvent payload) returns error?Parameters
- payload LabelEvent -
trigger.github: DeploymentService
onDeployment
Remote Function
function onDeployment(DeploymentEvent payload) returns error?Parameters
- payload DeploymentEvent -
trigger.github: TeamAddService
onTeamAdd
Remote Function
function onTeamAdd(TeamAddEvent payload) returns error?Parameters
- payload TeamAddEvent -
trigger.github: CodeScanningAlertService
onAppearedInBranch
Remote Function
function onAppearedInBranch(CodeScanningAlertEvent payload) returns error?Parameters
- payload CodeScanningAlertEvent -
onClosedByUser
Remote Function
function onClosedByUser(CodeScanningAlertEvent payload) returns error?Parameters
- payload CodeScanningAlertEvent -
onCreated
Remote Function
function onCreated(CodeScanningAlertEvent payload) returns error?Parameters
- payload CodeScanningAlertEvent -
onFixed
Remote Function
function onFixed(CodeScanningAlertEvent payload) returns error?Parameters
- payload CodeScanningAlertEvent -
onReopened
Remote Function
function onReopened(CodeScanningAlertEvent payload) returns error?Parameters
- payload CodeScanningAlertEvent -
onReopenedByUser
Remote Function
function onReopenedByUser(CodeScanningAlertEvent payload) returns error?Parameters
- payload CodeScanningAlertEvent -
onUpdatedAssignment
Remote Function
function onUpdatedAssignment(CodeScanningAlertEvent payload) returns error?Parameters
- payload CodeScanningAlertEvent -
trigger.github: MembershipService
onAdded
Remote Function
function onAdded(MembershipEvent payload) returns error?Parameters
- payload MembershipEvent -
onRemoved
Remote Function
function onRemoved(MembershipEvent payload) returns error?Parameters
- payload MembershipEvent -
trigger.github: SecretScanningAlertService
onAssigned
Remote Function
function onAssigned(SecretScanningAlertEvent payload) returns error?Parameters
- payload SecretScanningAlertEvent -
onReopened
Remote Function
function onReopened(SecretScanningAlertEvent payload) returns error?Parameters
- payload SecretScanningAlertEvent -
onUnassigned
Remote Function
function onUnassigned(SecretScanningAlertEvent payload) returns error?Parameters
- payload SecretScanningAlertEvent -
onCreated
Remote Function
function onCreated(SecretScanningAlertEvent payload) returns error?Parameters
- payload SecretScanningAlertEvent -
onPubliclyLeaked
Remote Function
function onPubliclyLeaked(SecretScanningAlertEvent payload) returns error?Parameters
- payload SecretScanningAlertEvent -
onValidated
Remote Function
function onValidated(SecretScanningAlertEvent payload) returns error?Parameters
- payload SecretScanningAlertEvent -
onResolved
Remote Function
function onResolved(SecretScanningAlertEvent payload) returns error?Parameters
- payload SecretScanningAlertEvent -
trigger.github: PushService
onPush
Remote Function
Parameters
- payload PushEvent -
trigger.github: MemberService
onEdited
Remote Function
function onEdited(MemberEvent payload) returns error?Parameters
- payload MemberEvent -
onAdded
Remote Function
function onAdded(MemberEvent payload) returns error?Parameters
- payload MemberEvent -
onRemoved
Remote Function
function onRemoved(MemberEvent payload) returns error?Parameters
- payload MemberEvent -
trigger.github: RepositoryDispatchService
onRepositoryDispatch
Remote Function
function onRepositoryDispatch(RepositoryDispatchEvent payload) returns error?Parameters
- payload RepositoryDispatchEvent -
trigger.github: StatusService
onStatus
Remote Function
function onStatus(StatusEvent payload) returns error?Parameters
- payload StatusEvent -
trigger.github: RepositoryImportService
onRepositoryImport
Remote Function
function onRepositoryImport(RepositoryImportEvent payload) returns error?Parameters
- payload RepositoryImportEvent -
trigger.github: PersonalAccessTokenRequestService
onCreated
Remote Function
function onCreated(PersonalAccessTokenRequestEvent payload) returns error?Parameters
- payload PersonalAccessTokenRequestEvent -
onApproved
Remote Function
function onApproved(PersonalAccessTokenRequestEvent payload) returns error?Parameters
- payload PersonalAccessTokenRequestEvent -
onDenied
Remote Function
function onDenied(PersonalAccessTokenRequestEvent payload) returns error?Parameters
- payload PersonalAccessTokenRequestEvent -
onCancelled
Remote Function
function onCancelled(PersonalAccessTokenRequestEvent payload) returns error?Parameters
- payload PersonalAccessTokenRequestEvent -
trigger.github: SubIssuesService
onChildIssueAdded
Remote Function
function onChildIssueAdded(SubIssuesEvent payload) returns error?Parameters
- payload SubIssuesEvent -
onParentIssueAdded
Remote Function
function onParentIssueAdded(SubIssuesEvent payload) returns error?Parameters
- payload SubIssuesEvent -
onChildIssueRemoved
Remote Function
function onChildIssueRemoved(SubIssuesEvent payload) returns error?Parameters
- payload SubIssuesEvent -
onParentIssueRemoved
Remote Function
function onParentIssueRemoved(SubIssuesEvent payload) returns error?Parameters
- payload SubIssuesEvent -
trigger.github: RepositoryRulesetService
onCreated
Remote Function
function onCreated(RepositoryRulesetEvent payload) returns error?Parameters
- payload RepositoryRulesetEvent -
onEdited
Remote Function
function onEdited(RepositoryRulesetEvent payload) returns error?Parameters
- payload RepositoryRulesetEvent -
onDeleted
Remote Function
function onDeleted(RepositoryRulesetEvent payload) returns error?Parameters
- payload RepositoryRulesetEvent -
trigger.github: MilestoneService
onCreated
Remote Function
function onCreated(MilestoneEvent payload) returns error?Parameters
- payload MilestoneEvent -
onEdited
Remote Function
function onEdited(MilestoneEvent payload) returns error?Parameters
- payload MilestoneEvent -
onOpened
Remote Function
function onOpened(MilestoneEvent payload) returns error?Parameters
- payload MilestoneEvent -
onDeleted
Remote Function
function onDeleted(MilestoneEvent payload) returns error?Parameters
- payload MilestoneEvent -
onClosed
Remote Function
function onClosed(MilestoneEvent payload) returns error?Parameters
- payload MilestoneEvent -
trigger.github: PublicService
onPublic
Remote Function
function onPublic(PublicEvent payload) returns error?Parameters
- payload PublicEvent -
trigger.github: WorkflowRunService
onInProgress
Remote Function
function onInProgress(WorkflowRunEvent payload) returns error?Parameters
- payload WorkflowRunEvent -
onCompleted
Remote Function
function onCompleted(WorkflowRunEvent payload) returns error?Parameters
- payload WorkflowRunEvent -
onRequested
Remote Function
function onRequested(WorkflowRunEvent payload) returns error?Parameters
- payload WorkflowRunEvent -
trigger.github: ProjectsV2statusUpdateService
onEdited
Remote Function
function onEdited('ProjectsV2StatusUpdateEvent payload) returns error?Parameters
- payload 'ProjectsV2StatusUpdateEvent -
onDeleted
Remote Function
function onDeleted('ProjectsV2StatusUpdateEvent payload) returns error?Parameters
- payload 'ProjectsV2StatusUpdateEvent -
onCreated
Remote Function
function onCreated('ProjectsV2StatusUpdateEvent payload) returns error?Parameters
- payload 'ProjectsV2StatusUpdateEvent -
trigger.github: ProjectsV2itemService
onEdited
Remote Function
function onEdited('ProjectsV2ItemEvent payload) returns error?Parameters
- payload 'ProjectsV2ItemEvent -
onCreated
Remote Function
function onCreated('ProjectsV2ItemEvent payload) returns error?Parameters
- payload 'ProjectsV2ItemEvent -
onArchived
Remote Function
function onArchived('ProjectsV2ItemEvent payload) returns error?Parameters
- payload 'ProjectsV2ItemEvent -
onDeleted
Remote Function
function onDeleted('ProjectsV2ItemEvent payload) returns error?Parameters
- payload 'ProjectsV2ItemEvent -
onRestored
Remote Function
function onRestored('ProjectsV2ItemEvent payload) returns error?Parameters
- payload 'ProjectsV2ItemEvent -
onReordered
Remote Function
function onReordered('ProjectsV2ItemEvent payload) returns error?Parameters
- payload 'ProjectsV2ItemEvent -
onConverted
Remote Function
function onConverted('ProjectsV2ItemEvent payload) returns error?Parameters
- payload 'ProjectsV2ItemEvent -
trigger.github: SponsorshipService
onCancelled
Remote Function
function onCancelled(SponsorshipEvent payload) returns error?Parameters
- payload SponsorshipEvent -
onEdited
Remote Function
function onEdited(SponsorshipEvent payload) returns error?Parameters
- payload SponsorshipEvent -
onTierChanged
Remote Function
function onTierChanged(SponsorshipEvent payload) returns error?Parameters
- payload SponsorshipEvent -
onPendingCancellation
Remote Function
function onPendingCancellation(SponsorshipEvent payload) returns error?Parameters
- payload SponsorshipEvent -
onCreated
Remote Function
function onCreated(SponsorshipEvent payload) returns error?Parameters
- payload SponsorshipEvent -
onPendingTierChange
Remote Function
function onPendingTierChange(SponsorshipEvent payload) returns error?Parameters
- payload SponsorshipEvent -
trigger.github: MergeGroupService
onDestroyed
Remote Function
function onDestroyed(MergeGroupEvent payload) returns error?Parameters
- payload MergeGroupEvent -
onChecksRequested
Remote Function
function onChecksRequested(MergeGroupEvent payload) returns error?Parameters
- payload MergeGroupEvent -
trigger.github: ProjectService
onDeleted
Remote Function
function onDeleted(ProjectEvent payload) returns error?Parameters
- payload ProjectEvent -
onCreated
Remote Function
function onCreated(ProjectEvent payload) returns error?Parameters
- payload ProjectEvent -
onClosed
Remote Function
function onClosed(ProjectEvent payload) returns error?Parameters
- payload ProjectEvent -
onReopened
Remote Function
function onReopened(ProjectEvent payload) returns error?Parameters
- payload ProjectEvent -
onEdited
Remote Function
function onEdited(ProjectEvent payload) returns error?Parameters
- payload ProjectEvent -
trigger.github: OrgBlockService
onBlocked
Remote Function
function onBlocked(OrgBlockEvent payload) returns error?Parameters
- payload OrgBlockEvent -
onUnblocked
Remote Function
function onUnblocked(OrgBlockEvent payload) returns error?Parameters
- payload OrgBlockEvent -
trigger.github: SecretScanningAlertLocationService
onSecretScanningAlertLocation
Remote Function
function onSecretScanningAlertLocation(SecretScanningAlertLocationEvent payload) returns error?Parameters
- payload SecretScanningAlertLocationEvent -
trigger.github: InstallationTargetService
onInstallationTarget
Remote Function
function onInstallationTarget(InstallationTargetEvent payload) returns error?Parameters
- payload InstallationTargetEvent -
trigger.github: CheckSuiteService
onCompleted
Remote Function
function onCompleted(CheckSuiteEvent payload) returns error?Parameters
- payload CheckSuiteEvent -
onRequested
Remote Function
function onRequested(CheckSuiteEvent payload) returns error?Parameters
- payload CheckSuiteEvent -
onRerequested
Remote Function
function onRerequested(CheckSuiteEvent payload) returns error?Parameters
- payload CheckSuiteEvent -
trigger.github: PingService
onPing
Remote Function
Parameters
- payload PingEvent -
trigger.github: IssueCommentService
onEdited
Remote Function
function onEdited(IssueCommentEvent payload) returns error?Parameters
- payload IssueCommentEvent -
onPinned
Remote Function
function onPinned(IssueCommentEvent payload) returns error?Parameters
- payload IssueCommentEvent -
onDeleted
Remote Function
function onDeleted(IssueCommentEvent payload) returns error?Parameters
- payload IssueCommentEvent -
onCreated
Remote Function
function onCreated(IssueCommentEvent payload) returns error?Parameters
- payload IssueCommentEvent -
onUnpinned
Remote Function
function onUnpinned(IssueCommentEvent payload) returns error?Parameters
- payload IssueCommentEvent -
trigger.github: SecurityAdvisoryService
onWithdrawn
Remote Function
function onWithdrawn(SecurityAdvisoryEvent payload) returns error?Parameters
- payload SecurityAdvisoryEvent -
onPublished
Remote Function
function onPublished(SecurityAdvisoryEvent payload) returns error?Parameters
- payload SecurityAdvisoryEvent -
onUpdated
Remote Function
function onUpdated(SecurityAdvisoryEvent payload) returns error?Parameters
- payload SecurityAdvisoryEvent -
trigger.github: PackageService
onPublished
Remote Function
function onPublished(PackageEvent payload) returns error?Parameters
- payload PackageEvent -
onUpdated
Remote Function
function onUpdated(PackageEvent payload) returns error?Parameters
- payload PackageEvent -
trigger.github: DiscussionService
onUnanswered
Remote Function
function onUnanswered(DiscussionEvent payload) returns error?Parameters
- payload DiscussionEvent -
onCreated
Remote Function
function onCreated(DiscussionEvent payload) returns error?Parameters
- payload DiscussionEvent -
onTransferred
Remote Function
function onTransferred(DiscussionEvent payload) returns error?Parameters
- payload DiscussionEvent -
onCategoryChanged
Remote Function
function onCategoryChanged(DiscussionEvent payload) returns error?Parameters
- payload DiscussionEvent -
onDeleted
Remote Function
function onDeleted(DiscussionEvent payload) returns error?Parameters
- payload DiscussionEvent -
onUnlocked
Remote Function
function onUnlocked(DiscussionEvent payload) returns error?Parameters
- payload DiscussionEvent -
onPinned
Remote Function
function onPinned(DiscussionEvent payload) returns error?Parameters
- payload DiscussionEvent -
onEdited
Remote Function
function onEdited(DiscussionEvent payload) returns error?Parameters
- payload DiscussionEvent -
onReopened
Remote Function
function onReopened(DiscussionEvent payload) returns error?Parameters
- payload DiscussionEvent -
onAnswered
Remote Function
function onAnswered(DiscussionEvent payload) returns error?Parameters
- payload DiscussionEvent -
onClosed
Remote Function
function onClosed(DiscussionEvent payload) returns error?Parameters
- payload DiscussionEvent -
onUnlabeled
Remote Function
function onUnlabeled(DiscussionEvent payload) returns error?Parameters
- payload DiscussionEvent -
onLabeled
Remote Function
function onLabeled(DiscussionEvent payload) returns error?Parameters
- payload DiscussionEvent -
onUnpinned
Remote Function
function onUnpinned(DiscussionEvent payload) returns error?Parameters
- payload DiscussionEvent -
onLocked
Remote Function
function onLocked(DiscussionEvent payload) returns error?Parameters
- payload DiscussionEvent -
trigger.github: ForkService
onFork
Remote Function
Parameters
- payload ForkEvent -
trigger.github: PullRequestReviewService
onSubmitted
Remote Function
function onSubmitted(PullRequestReviewEvent payload) returns error?Parameters
- payload PullRequestReviewEvent -
onEdited
Remote Function
function onEdited(PullRequestReviewEvent payload) returns error?Parameters
- payload PullRequestReviewEvent -
onDismissed
Remote Function
function onDismissed(PullRequestReviewEvent payload) returns error?Parameters
- payload PullRequestReviewEvent -
trigger.github: OrganizationService
onAdded
Remote Function
function onAdded(OrganizationEvent payload) returns error?Parameters
- payload OrganizationEvent -
onRemoved
Remote Function
function onRemoved(OrganizationEvent payload) returns error?Parameters
- payload OrganizationEvent -
onDeleted
Remote Function
function onDeleted(OrganizationEvent payload) returns error?Parameters
- payload OrganizationEvent -
onRenamed
Remote Function
function onRenamed(OrganizationEvent payload) returns error?Parameters
- payload OrganizationEvent -
onMemberInvited
Remote Function
function onMemberInvited(OrganizationEvent payload) returns error?Parameters
- payload OrganizationEvent -
trigger.github: IssuesService
onReopened
Remote Function
function onReopened(IssuesEvent payload) returns error?Parameters
- payload IssuesEvent -
onTransferred
Remote Function
function onTransferred(IssuesEvent payload) returns error?Parameters
- payload IssuesEvent -
onUnpinned
Remote Function
function onUnpinned(IssuesEvent payload) returns error?Parameters
- payload IssuesEvent -
onAssigned
Remote Function
function onAssigned(IssuesEvent payload) returns error?Parameters
- payload IssuesEvent -
onMilestoned
Remote Function
function onMilestoned(IssuesEvent payload) returns error?Parameters
- payload IssuesEvent -
onLabeled
Remote Function
function onLabeled(IssuesEvent payload) returns error?Parameters
- payload IssuesEvent -
onOpened
Remote Function
function onOpened(IssuesEvent payload) returns error?Parameters
- payload IssuesEvent -
onPinned
Remote Function
function onPinned(IssuesEvent payload) returns error?Parameters
- payload IssuesEvent -
onTyped
Remote Function
function onTyped(IssuesEvent payload) returns error?Parameters
- payload IssuesEvent -
onEdited
Remote Function
function onEdited(IssuesEvent payload) returns error?Parameters
- payload IssuesEvent -
onUntyped
Remote Function
function onUntyped(IssuesEvent payload) returns error?Parameters
- payload IssuesEvent -
onDemilestoned
Remote Function
function onDemilestoned(IssuesEvent payload) returns error?Parameters
- payload IssuesEvent -
onLocked
Remote Function
function onLocked(IssuesEvent payload) returns error?Parameters
- payload IssuesEvent -
onUnassigned
Remote Function
function onUnassigned(IssuesEvent payload) returns error?Parameters
- payload IssuesEvent -
onUnlocked
Remote Function
function onUnlocked(IssuesEvent payload) returns error?Parameters
- payload IssuesEvent -
onUnlabeled
Remote Function
function onUnlabeled(IssuesEvent payload) returns error?Parameters
- payload IssuesEvent -
onClosed
Remote Function
function onClosed(IssuesEvent payload) returns error?Parameters
- payload IssuesEvent -
onDeleted
Remote Function
function onDeleted(IssuesEvent payload) returns error?Parameters
- payload IssuesEvent -
trigger.github: RegistryPackageService
onUpdated
Remote Function
function onUpdated(RegistryPackageEvent payload) returns error?Parameters
- payload RegistryPackageEvent -
onPublished
Remote Function
function onPublished(RegistryPackageEvent payload) returns error?Parameters
- payload RegistryPackageEvent -
trigger.github: ProjectsV2Service
onCreated
Remote Function
function onCreated('ProjectsV2Event payload) returns error?Parameters
- payload 'ProjectsV2Event -
onEdited
Remote Function
function onEdited('ProjectsV2Event payload) returns error?Parameters
- payload 'ProjectsV2Event -
onClosed
Remote Function
function onClosed('ProjectsV2Event payload) returns error?Parameters
- payload 'ProjectsV2Event -
onReopened
Remote Function
function onReopened('ProjectsV2Event payload) returns error?Parameters
- payload 'ProjectsV2Event -
onDeleted
Remote Function
function onDeleted('ProjectsV2Event payload) returns error?Parameters
- payload 'ProjectsV2Event -
trigger.github: RepositoryVulnerabilityAlertService
onResolve
Remote Function
function onResolve(RepositoryVulnerabilityAlertEvent payload) returns error?Parameters
- payload RepositoryVulnerabilityAlertEvent -
onReopen
Remote Function
function onReopen(RepositoryVulnerabilityAlertEvent payload) returns error?Parameters
- payload RepositoryVulnerabilityAlertEvent -
onDismiss
Remote Function
function onDismiss(RepositoryVulnerabilityAlertEvent payload) returns error?Parameters
- payload RepositoryVulnerabilityAlertEvent -
onCreate
Remote Function
function onCreate(RepositoryVulnerabilityAlertEvent payload) returns error?Parameters
- payload RepositoryVulnerabilityAlertEvent -
trigger.github: StarService
onCreated
Remote Function
Parameters
- payload StarEvent -
onDeleted
Remote Function
Parameters
- payload StarEvent -
trigger.github: CreateService
onCreate
Remote Function
function onCreate(CreateEvent payload) returns error?Parameters
- payload CreateEvent -
trigger.github: DeploymentReviewService
onRequested
Remote Function
function onRequested(DeploymentReviewEvent payload) returns error?Parameters
- payload DeploymentReviewEvent -
onRejected
Remote Function
function onRejected(DeploymentReviewEvent payload) returns error?Parameters
- payload DeploymentReviewEvent -
onApproved
Remote Function
function onApproved(DeploymentReviewEvent payload) returns error?Parameters
- payload DeploymentReviewEvent -
trigger.github: GollumService
onGollum
Remote Function
function onGollum(GollumEvent payload) returns error?Parameters
- payload GollumEvent -
trigger.github: GithubAppAuthorizationService
onGithubAppAuthorization
Remote Function
function onGithubAppAuthorization(GithubAppAuthorizationEvent payload) returns error?Parameters
- payload GithubAppAuthorizationEvent -
trigger.github: WatchService
onWatch
Remote Function
function onWatch(WatchEvent payload) returns error?Parameters
- payload WatchEvent -
trigger.github: TeamService
onCreated
Remote Function
Parameters
- payload TeamEvent -
onDeleted
Remote Function
Parameters
- payload TeamEvent -
onEdited
Remote Function
Parameters
- payload TeamEvent -
onAddedToRepository
Remote Function
Parameters
- payload TeamEvent -
onRemovedFromRepository
Remote Function
Parameters
- payload TeamEvent -
trigger.github: WorkflowJobService
onQueued
Remote Function
function onQueued(WorkflowJobEvent payload) returns error?Parameters
- payload WorkflowJobEvent -
onWaiting
Remote Function
function onWaiting(WorkflowJobEvent payload) returns error?Parameters
- payload WorkflowJobEvent -
onCompleted
Remote Function
function onCompleted(WorkflowJobEvent payload) returns error?Parameters
- payload WorkflowJobEvent -
onInProgress
Remote Function
function onInProgress(WorkflowJobEvent payload) returns error?Parameters
- payload WorkflowJobEvent -
trigger.github: ReleaseService
onCreated
Remote Function
function onCreated(ReleaseEvent payload) returns error?Parameters
- payload ReleaseEvent -
onPublished
Remote Function
function onPublished(ReleaseEvent payload) returns error?Parameters
- payload ReleaseEvent -
onReleased
Remote Function
function onReleased(ReleaseEvent payload) returns error?Parameters
- payload ReleaseEvent -
onPrereleased
Remote Function
function onPrereleased(ReleaseEvent payload) returns error?Parameters
- payload ReleaseEvent -
onUnpublished
Remote Function
function onUnpublished(ReleaseEvent payload) returns error?Parameters
- payload ReleaseEvent -
onDeleted
Remote Function
function onDeleted(ReleaseEvent payload) returns error?Parameters
- payload ReleaseEvent -
onEdited
Remote Function
function onEdited(ReleaseEvent payload) returns error?Parameters
- payload ReleaseEvent -
trigger.github: InstallationService
onNewPermissionsAccepted
Remote Function
function onNewPermissionsAccepted(InstallationEvent payload) returns error?Parameters
- payload InstallationEvent -
onSuspend
Remote Function
function onSuspend(InstallationEvent payload) returns error?Parameters
- payload InstallationEvent -
onCreated
Remote Function
function onCreated(InstallationEvent payload) returns error?Parameters
- payload InstallationEvent -
onDeleted
Remote Function
function onDeleted(InstallationEvent payload) returns error?Parameters
- payload InstallationEvent -
onUnsuspend
Remote Function
function onUnsuspend(InstallationEvent payload) returns error?Parameters
- payload InstallationEvent -
trigger.github: CommitCommentService
onCommitComment
Remote Function
function onCommitComment(CommitCommentEvent payload) returns error?Parameters
- payload CommitCommentEvent -
trigger.github: DiscussionCommentService
onDeleted
Remote Function
function onDeleted(DiscussionCommentEvent payload) returns error?Parameters
- payload DiscussionCommentEvent -
onCreated
Remote Function
function onCreated(DiscussionCommentEvent payload) returns error?Parameters
- payload DiscussionCommentEvent -
onEdited
Remote Function
function onEdited(DiscussionCommentEvent payload) returns error?Parameters
- payload DiscussionCommentEvent -
trigger.github: BranchProtectionRuleService
onDeleted
Remote Function
function onDeleted(BranchProtectionRuleEvent payload) returns error?Parameters
- payload BranchProtectionRuleEvent -
onEdited
Remote Function
function onEdited(BranchProtectionRuleEvent payload) returns error?Parameters
- payload BranchProtectionRuleEvent -
onCreated
Remote Function
function onCreated(BranchProtectionRuleEvent payload) returns error?Parameters
- payload BranchProtectionRuleEvent -
trigger.github: IssueDependenciesService
onIssueDependencyAdded
Remote Function
function onIssueDependencyAdded(IssueDependenciesEvent payload) returns error?Parameters
- payload IssueDependenciesEvent -
onIssueDependencyRemoved
Remote Function
function onIssueDependencyRemoved(IssueDependenciesEvent payload) returns error?Parameters
- payload IssueDependenciesEvent -
trigger.github: RepositoryService
onPrivatized
Remote Function
function onPrivatized(RepositoryEvent payload) returns error?Parameters
- payload RepositoryEvent -
onCreated
Remote Function
function onCreated(RepositoryEvent payload) returns error?Parameters
- payload RepositoryEvent -
onRenamed
Remote Function
function onRenamed(RepositoryEvent payload) returns error?Parameters
- payload RepositoryEvent -
onTransferred
Remote Function
function onTransferred(RepositoryEvent payload) returns error?Parameters
- payload RepositoryEvent -
onEdited
Remote Function
function onEdited(RepositoryEvent payload) returns error?Parameters
- payload RepositoryEvent -
onDeleted
Remote Function
function onDeleted(RepositoryEvent payload) returns error?Parameters
- payload RepositoryEvent -
onArchived
Remote Function
function onArchived(RepositoryEvent payload) returns error?Parameters
- payload RepositoryEvent -
onPublicized
Remote Function
function onPublicized(RepositoryEvent payload) returns error?Parameters
- payload RepositoryEvent -
onUnarchived
Remote Function
function onUnarchived(RepositoryEvent payload) returns error?Parameters
- payload RepositoryEvent -
trigger.github: PullRequestReviewCommentService
onCreated
Remote Function
function onCreated(PullRequestReviewCommentEvent payload) returns error?Parameters
- payload PullRequestReviewCommentEvent -
onDeleted
Remote Function
function onDeleted(PullRequestReviewCommentEvent payload) returns error?Parameters
- payload PullRequestReviewCommentEvent -
onEdited
Remote Function
function onEdited(PullRequestReviewCommentEvent payload) returns error?Parameters
- payload PullRequestReviewCommentEvent -
trigger.github: DeploymentProtectionRuleService
onDeploymentProtectionRule
Remote Function
function onDeploymentProtectionRule(DeploymentProtectionRuleEvent payload) returns error?Parameters
- payload DeploymentProtectionRuleEvent -
trigger.github: CustomPropertyValuesService
onCustomPropertyValues
Remote Function
function onCustomPropertyValues(CustomPropertyValuesEvent payload) returns error?Parameters
- payload CustomPropertyValuesEvent -
trigger.github: InstallationRepositoriesService
onRemoved
Remote Function
function onRemoved(InstallationRepositoriesEvent payload) returns error?Parameters
- payload InstallationRepositoriesEvent -
onAdded
Remote Function
function onAdded(InstallationRepositoriesEvent payload) returns error?Parameters
- payload InstallationRepositoriesEvent -
trigger.github: SecretScanningScanService
onSecretScanningScan
Remote Function
function onSecretScanningScan(SecretScanningScanEvent payload) returns error?Parameters
- payload SecretScanningScanEvent -
trigger.github: ProjectCardService
onProjectCardEdited
Remote Function
function onProjectCardEdited(ProjectCardEvent payload) returns error?Parameters
- payload ProjectCardEvent -
onProjectCardDeleted
Remote Function
function onProjectCardDeleted(ProjectCardEvent payload) returns error?Parameters
- payload ProjectCardEvent -
onProjectCardMoved
Remote Function
function onProjectCardMoved(ProjectCardEvent payload) returns error?Parameters
- payload ProjectCardEvent -
onProjectCardConverted
Remote Function
function onProjectCardConverted(ProjectCardEvent payload) returns error?Parameters
- payload ProjectCardEvent -
onProjectCardCreated
Remote Function
function onProjectCardCreated(ProjectCardEvent payload) returns error?Parameters
- payload ProjectCardEvent -
trigger.github: CheckRunService
onCreated
Remote Function
function onCreated(CheckRunEvent payload) returns error?Parameters
- payload CheckRunEvent -
onCompleted
Remote Function
function onCompleted(CheckRunEvent payload) returns error?Parameters
- payload CheckRunEvent -
onRequestedAction
Remote Function
function onRequestedAction(CheckRunEvent payload) returns error?Parameters
- payload CheckRunEvent -
onRerequested
Remote Function
function onRerequested(CheckRunEvent payload) returns error?Parameters
- payload CheckRunEvent -
trigger.github: PageBuildService
onPageBuild
Remote Function
function onPageBuild(PageBuildEvent payload) returns error?Parameters
- payload PageBuildEvent -
trigger.github: CustomPropertyService
onUpdated
Remote Function
function onUpdated(CustomPropertyEvent payload) returns error?Parameters
- payload CustomPropertyEvent -
onDeleted
Remote Function
function onDeleted(CustomPropertyEvent payload) returns error?Parameters
- payload CustomPropertyEvent -
onPromoteToEnterprise
Remote Function
function onPromoteToEnterprise(CustomPropertyEvent payload) returns error?Parameters
- payload CustomPropertyEvent -
onCreated
Remote Function
function onCreated(CustomPropertyEvent payload) returns error?Parameters
- payload CustomPropertyEvent -
trigger.github: DependabotAlertService
onAutoDismissed
Remote Function
function onAutoDismissed(DependabotAlertEvent payload) returns error?Parameters
- payload DependabotAlertEvent -
onAutoReopened
Remote Function
function onAutoReopened(DependabotAlertEvent payload) returns error?Parameters
- payload DependabotAlertEvent -
onCreated
Remote Function
function onCreated(DependabotAlertEvent payload) returns error?Parameters
- payload DependabotAlertEvent -
onDismissed
Remote Function
function onDismissed(DependabotAlertEvent payload) returns error?Parameters
- payload DependabotAlertEvent -
onReopened
Remote Function
function onReopened(DependabotAlertEvent payload) returns error?Parameters
- payload DependabotAlertEvent -
onReintroduced
Remote Function
function onReintroduced(DependabotAlertEvent payload) returns error?Parameters
- payload DependabotAlertEvent -
onAssigneesChanged
Remote Function
function onAssigneesChanged(DependabotAlertEvent payload) returns error?Parameters
- payload DependabotAlertEvent -
onFixed
Remote Function
function onFixed(DependabotAlertEvent payload) returns error?Parameters
- payload DependabotAlertEvent -
trigger.github: DeploymentStatusService
onDeploymentStatus
Remote Function
function onDeploymentStatus(DeploymentStatusEvent payload) returns error?Parameters
- payload DeploymentStatusEvent -
trigger.github: RepositoryAdvisoryService
onReported
Remote Function
function onReported(RepositoryAdvisoryEvent payload) returns error?Parameters
- payload RepositoryAdvisoryEvent -
onPublished
Remote Function
function onPublished(RepositoryAdvisoryEvent payload) returns error?Parameters
- payload RepositoryAdvisoryEvent -
trigger.github: PullRequestReviewThreadService
onUnresolved
Remote Function
function onUnresolved(PullRequestReviewThreadEvent payload) returns error?Parameters
- payload PullRequestReviewThreadEvent -
onResolved
Remote Function
function onResolved(PullRequestReviewThreadEvent payload) returns error?Parameters
- payload PullRequestReviewThreadEvent -
Listeners
trigger.github: Listener
attach
Isolated Function
function attach(GenericServiceType serviceRef, () attachPoint) returns error?detach
Isolated Function
function detach(GenericServiceType serviceRef) returns error?Parameters
- serviceRef GenericServiceType -
'start
Isolated Function
function 'start() returns error?gracefulStop
Isolated Function
function gracefulStop() returns error?immediateStop
Isolated Function
function immediateStop() returns error?Records
trigger.github: 'ProjectsV2Event
Fields
- action string -
- sender? User -
- organization? Organization -
- installation? Installation -
trigger.github: 'ProjectsV2ItemEvent
Fields
- action string -
- sender? User -
- organization? Organization -
- installation? Installation -
trigger.github: 'ProjectsV2StatusUpdateEvent
Fields
- action string -
- sender? User -
- organization? Organization -
- installation? Installation -
trigger.github: BranchProtectionConfigurationEvent
Fields
- action string - disabled — all branch protections were disabled. enabled — all were enabled.
- sender? User -
- repository? Repository -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: BranchProtectionRuleEvent
Fields
- action string -
- rule record { id int, repository_id int, name string, created_at string, updated_at string, pull_request_reviews_enforcement_level string, required_approving_review_count int, dismiss_stale_reviews_on_push boolean, require_code_owner_review boolean, authorized_dismissal_actors_only boolean, ignore_approvals_from_contributors boolean, require_last_push_approval boolean, required_status_checks string[], required_status_checks_enforcement_level string, strict_required_status_checks_policy boolean, signature_requirement_enforcement_level string, linear_history_requirement_enforcement_level string, admin_enforced boolean, allow_force_pushes_enforcement_level string, allow_deletions_enforcement_level string, merge_queue_enforcement_level string, required_deployments_enforcement_level string, required_conversation_resolution_level string, authorized_actors_only boolean, authorized_actor_names string[] } - The branch protection rule. Includes name and all branch protection settings applied to matching branches. Binary settings are boolean; multi-level configs are off, non_admins, or everyone; actor and build lists are arrays of strings.
- changes? record {} - For edited events, the changes to the rule
- sender? User -
- repository? Repository -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: CheckRun
Fields
- id int -
- name string -
- node_id? string -
- head_sha? string -
- external_id? string -
- url? string -
- html_url? string -
- details_url? string -
- status? string -
- conclusion? string -
- started_at? string -
- completed_at? string -
- check_suite? record { id int } -
- app? record {} -
- pull_requests? record {}[] -
trigger.github: CheckRunEvent
Fields
- action string -
- check_run CheckRun -
- requested_action? record { identifier string } - Present for requested_action events
- sender? User -
- repository? Repository -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: CheckSuite
Fields
- id int -
- node_id? string -
- head_branch? string -
- head_sha? string -
- status? string -
- conclusion? string -
- url? string -
- before? string -
- after? string -
- pull_requests? record {}[] -
- app? record {} -
- created_at? string -
- updated_at? string -
trigger.github: CheckSuiteEvent
Fields
- action string -
- check_suite CheckSuite -
- sender? User -
- repository? Repository -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: CodeScanningAlertEvent
Fields
- action string -
- alert record { number int, created_at string, updated_at string, url string, html_url string, state string, fixed_at string, dismissed_by User, dismissed_at string, dismissed_reason string, dismissed_comment string, rule record { id string, severity string, security_severity_level string, description string, name string, full_description string, tags string[], help string }, tool record { name string, guid string, 'version string }, most_recent_instance record { ref string, analysis_key string, environment string, state string, commit_sha string, location record {} } } - The code scanning alert involved in the event
- commit_oid string - The commit SHA of the alert. Empty when action is reopened_by_user or closed_by_user.
- ref string - The git ref of the alert. Empty when action is reopened_by_user or closed_by_user.
- sender? User -
- repository? Repository -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: Commit
Fields
- id string - The commit SHA
- tree_id? string -
- 'distinct? boolean - Whether this commit is distinct from any that have been pushed before
- message string -
- timestamp? string -
- url? string -
- committer? CommitAuthor -
- added? string[] - Files added in this commit
- removed? string[] - Files removed in this commit
- modified? string[] - Files modified in this commit
trigger.github: CommitAuthor
Fields
- name? string -
- email? string -
- username? string -
trigger.github: CommitCommentEvent
Fields
- action string -
- sender? User -
- repository? Repository -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: CommonEvent
Fields
- sender? User -
- repository? Repository -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: CreateEvent
Fields
- ref string - The git ref resource (branch or tag name)
- ref_type string - The type of Git ref object created
- master_branch string - The name of the repository's default branch (usually main)
- description? string - The repository's current description
- pusher_type string - The pusher type; either user or a deploy key
- sender User -
- repository Repository -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: CustomPropertyEvent
Fields
- action string -
- sender? User -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: CustomPropertyValuesEvent
Fields
- action string -
- new_property_values record { property_name string, value anydata }[] - The new custom property values for the repository
- old_property_values record { property_name string, value anydata }[] - The old custom property values for the repository
- sender? User -
- repository? Repository -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: DeleteEvent
Fields
- ref string - The git ref resource (branch or tag name)
- ref_type string - The type of Git ref object deleted
- pusher_type string - The pusher type; either user or a deploy key
- sender User -
- repository Repository -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: DependabotAlertEvent
Fields
- action string -
- alert record { number int, state string, dependency record { package record { ecosystem string, name string }, manifest_path string, scope string }, security_advisory record { ghsa_id string, cve_id string, summary string, description string, severity string, vulnerabilities record {}[] }, security_vulnerability record { package record {}, severity string, vulnerable_version_range string, first_patched_version record { identifier string } }, url string, html_url string, created_at string, updated_at string, dismissed_at string, dismissed_by User, dismissed_reason string, dismissed_comment string, fixed_at string, auto_dismissed_at string, assignees User[] } - A Dependabot alert
- sender? User -
- repository? Repository -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: DeployKeyEvent
Fields
- action string -
- sender? User -
- repository? Repository -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: Deployment
Fields
- id int -
- node_id? string -
- sha string -
- ref string -
- task string -
- payload? record {} -
- original_environment? string -
- environment string -
- description? string -
- creator? User -
- created_at? string -
- updated_at? string -
- statuses_url? string -
- repository_url? string -
- transient_environment? boolean -
- production_environment? boolean -
- performed_via_github_app? record {} -
trigger.github: DeploymentEvent
Fields
- action string -
- deployment Deployment -
- workflow record {} - The workflow that triggered the deployment (if applicable)
- workflow_run record {} - The workflow run that triggered the deployment (if applicable)
- sender User -
- repository Repository -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: DeploymentProtectionRuleEvent
Fields
- environment? string - The name of the environment that has the deployment protection rule
- event? string - The event that triggered the deployment protection rule
- sha? string - The commit SHA that triggered the workflow
- ref? string - The branch or tag ref that triggered the workflow
- deployment_callback_url? string - The URL to call to approve or reject the deployment
- deployment? Deployment - A request for a specific ref to be deployed
- pull_requests? record { number int, url string, head PullRequestRef, base PullRequestRef }[] - The pull requests associated with the deployment
- sender? User -
- installation? Installation -
- repository? Repository -
- organization? Organization -
trigger.github: DeploymentReviewEvent
Fields
- action string -
- environment string - The name of the environment that was approved or rejected
- comment? string - The reviewer's comment (for approved/rejected)
- since string - ISO 8601 date of when the review was requested
- reviewers? record { 'type string, reviewer anydata }[] - The reviewers who were requested or who reviewed
- sender? User -
- repository? Repository -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: DeploymentStatus
Fields
- id int -
- node_id? string -
- state string -
- creator? User -
- description? string -
- environment? string -
- environment_url? string -
- log_url? string -
- target_url? string -
- deployment_url? string -
- repository_url? string -
- created_at? string -
- updated_at? string -
- performed_via_github_app? record {} -
trigger.github: DeploymentStatusEvent
Fields
- action string -
- deployment Deployment -
- deployment_status DeploymentStatus -
- check_run? CheckRun -
- workflow? record {} -
- workflow_run? record {} -
- sender User -
- repository Repository -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: Discussion
Fields
- id int -
- node_id? string -
- number int -
- title string -
- body? string -
- state string -
- user? User -
- html_url? string -
- comments? int -
- labels? Label[] -
- locked? boolean -
- active_lock_reason? string -
- answer_html_url? string -
- answer_chosen_at? string -
- answer_chosen_by? User -
- created_at? string -
- updated_at? string -
trigger.github: DiscussionCommentEvent
Fields
- action string -
- discussion Discussion -
- changes? record {} - For edited events, the changes to the comment
- sender? User -
- repository? Repository -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: DiscussionEvent
Fields
- action string -
- discussion Discussion -
- answer? record {} - Present on answered action — the comment marked as answer
- label? Label -
- changes? record {} - For edited/category_changed events, the changes made
- sender? User -
- repository? Repository -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: Enterprise
Fields
- id? int -
- slug? string -
- name? string -
- node_id? string -
- avatar_url? string -
- description? string -
- website_url? string -
- html_url? string -
- created_at? string -
- updated_at? string -
trigger.github: ForkEvent
Fields
- forkee Repository - The created (forked) repository
- sender User -
- repository Repository -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: GithubAppAuthorizationEvent
Fields
- action string - Always revoked — a user revoked their GitHub App authorization
- sender? User -
- installation? Installation -
trigger.github: GollumEvent
Fields
- sender User -
- repository Repository -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: Installation
Fields
- id? int -
- node_id? string -
trigger.github: InstallationEvent
Fields
- action string -
- installation Installation -
- requester? User -
- sender? User -
- organization? Organization -
- enterprise? Enterprise -
trigger.github: InstallationRepositoriesEvent
Fields
- action string -
- repository_selection string - Whether all repositories or a selection are accessible
- requester User -
- installation? Installation -
- sender? User -
- organization? Organization -
- enterprise? Enterprise -
trigger.github: InstallationTargetEvent
Fields
- action string -
- target_type string -
- installation? Installation -
trigger.github: Issue
Fields
- id int -
- node_id? string -
- url? string -
- html_url? string -
- number int -
- title string -
- body? string -
- state string -
- locked? boolean -
- user User -
- labels? Label[] -
- assignee? User -
- assignees? User[] -
- milestone? Milestone -
- comments? int -
- created_at? string -
- updated_at? string -
- closed_at? string -
- active_lock_reason? string -
trigger.github: IssueComment
Fields
- id int -
- node_id? string -
- url? string -
- html_url? string -
- body string -
- user User -
- created_at? string -
- updated_at? string -
trigger.github: IssueCommentEvent
Fields
- action string -
- issue Issue -
- comment IssueComment -
- changes? record {} - For edited events, the changes to the comment
- sender User -
- repository Repository -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: IssueDependenciesEvent
Fields
- action string -
- blocked_issue_id? int -
- blocked_issue? Issue -
- blocking_issue_id? int -
- blocking_issue? Issue -
- blocking_issue_repo? Repository -
- sender? User -
- repository? Repository -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: IssuesEvent
Fields
- action string - The action that was performed
- issue Issue -
- assignee? User -
- label? Label -
- changes? record {} - For edited events, the changes to the issue
- milestone? Milestone -
- sender User -
- repository Repository -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: Label
Fields
- id int -
- node_id? string -
- url? string -
- name string -
- color string - 6-character hex color code
- 'default? boolean -
- description? string -
trigger.github: LabelEvent
Fields
- action string -
- label Label -
- sender User -
- repository Repository -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: ListenerConfig
Fields
- webhookSecret string(default DEFAULT_SECRET) -
trigger.github: MarketplacePurchaseEvent
Fields
- action string -
- marketplace_purchase record { account record { 'type string, id int, node_id string, login string, organization_billing_email string }, billing_cycle string, unit_count int, on_free_trial boolean, free_trial_ends_on string, next_billing_date string, plan record { id int, name string, description string, monthly_price_in_cents int, yearly_price_in_cents int, price_model string, has_free_trial boolean, unit_name string, bullets string[] } } - The GitHub Marketplace purchase
- previous_marketplace_purchase? record {} - The previous purchase state (for changed/pending_change events)
- effective_date string - ISO 8601 date when the change takes effect
- sender User -
- installation? Installation -
trigger.github: MemberEvent
Fields
- action string -
- member User -
- sender User -
- repository Repository -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: MembershipEvent
Fields
- action string -
- member User -
- scope string - The scope of the membership (currently always "team")
- team Team -
- sender? User -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: MergeGroupEvent
Fields
- action string -
- reason? string - For destroyed action, the reason the merge group was destroyed
- sender? User -
- repository? Repository -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: MetaEvent
Fields
- action string - Always deleted — the webhook that triggered this event was deleted
- hook_id int - The id of the modified webhook
- hook record { 'type string, id int, name string, active boolean, events string[], config record { content_type string, insecure_ssl string, url string, secret string }, updated_at string, created_at string } - The deleted webhook. Fields vary by webhook type (repository, organization, business, app, or GitHub Marketplace).
- sender? User -
- repository? Repository -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: Milestone
Fields
- id? int -
- node_id? string -
- number? int -
- title? string -
- description? string -
- state? string -
- open_issues? int -
- closed_issues? int -
- created_at? string -
- updated_at? string -
- due_on? string -
- closed_at? string -
- creator? User -
trigger.github: MilestoneEvent
Fields
- action string -
- milestone Milestone -
- sender User -
- repository Repository -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: Organization
Fields
- login? string -
- id? int -
- node_id? string -
- url? string -
- html_url? string -
- repos_url? string -
- avatar_url? string -
- description? string -
trigger.github: OrganizationEvent
Fields
- action string -
- invitation? record {} - Present when action is member_invited
- changes? record {} - For renamed events, the old and new organization name
- sender? User -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: OrgBlockEvent
Fields
- action string -
- blocked_user User -
- sender? User -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: PackageEvent
Fields
- action string -
- package record { id int, name string, namespace string, description string, ecosystem string, package_type string, html_url string, created_at string, updated_at string, owner User, package_version record { id int, 'version string, summary string, name string, description string, body string, body_html string, release record {}, manifest string, html_url string, tag_name string, target_commitish string, target_oid string, draft boolean, prerelease boolean, created_at string, updated_at string, metadata record {}[], container_metadata record {}, npm_metadata record {}, nuget_metadata record {}[], rubygems_metadata record {}[], package_files record {}[], package_url string, author User, source_url string, installation_command string }, registry record { about_url string, name string, 'type string, url string, vendor string } } - Information about the package
- sender? User -
- repository? Repository -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: PageBuildEvent
Fields
- id int - The unique identifier of the page build
- sender? User -
- repository? Repository -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: PersonalAccessTokenRequestEvent
Fields
- action string -
- personal_access_token_request record { id int, owner User, permissions_added record { organization record {}, repository record {}, other record {} }, permissions_upgraded record { organization record {}, repository record {}, other record {} }, permissions_result record { organization record {}, repository record {}, other record {} }, repository_selection string, repositories_url string, repositories Repository[], token_expired boolean, token_expires_at string, token_last_used_at string, created_at string } - A fine-grained personal access token request
- sender? User -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: PingEvent
Fields
- zen? string - Random string of GitHub zen
- hook_id? int - The ID of the webhook that triggered the ping
- sender? User -
- repository? Repository -
- organization? Organization -
trigger.github: ProjectCardEvent
Fields
- action string -
- sender? User -
- repository? Repository -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: ProjectColumnEvent
Fields
- action string -
- changes? record { name record { 'from string } } - For edited events, the changes made to the column
- sender? User -
- repository? Repository -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: ProjectEvent
Fields
- action string -
- sender? User -
- repository? Repository -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: PublicEvent
Fields
- sender User -
- repository Repository -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: PullRequest
Fields
- id int -
- node_id? string -
- url? string -
- html_url? string -
- diff_url? string -
- patch_url? string -
- number int -
- state string -
- locked? boolean -
- title string -
- body? string -
- user User -
- labels? Label[] -
- assignee? User -
- assignees? User[] -
- milestone? Milestone -
- head? PullRequestRef -
- base? PullRequestRef -
- draft? boolean -
- merged? boolean -
- mergeable? boolean -
- rebaseable? boolean -
- mergeable_state? string -
- merge_commit_sha? string -
- comments? int -
- review_comments? int -
- commits? int -
- additions? int -
- deletions? int -
- changed_files? int -
- created_at? string -
- updated_at? string -
- closed_at? string -
- merged_at? string -
- merged_by? User -
- auto_merge? record {} -
trigger.github: PullRequestEvent
Fields
- action string - The action that was performed
- number int - The pull request number
- pull_request PullRequest -
- assignee User -
- changes? record {} - For edited events, the changes to the pull request
- requested_reviewer? User -
- label? Label -
- milestone? Milestone -
- sender User -
- repository Repository -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: PullRequestRef
Fields
- label? string -
- ref? string -
- sha? string -
- user? User -
- repo? Repository -
trigger.github: PullRequestReview
Fields
- id int -
- node_id? string -
- user User -
- body? string -
- state string -
- html_url? string -
- pull_request_url? string -
- submitted_at? string -
- commit_id? string -
trigger.github: PullRequestReviewComment
Fields
- id int -
- node_id? string -
- pull_request_review_id? int -
- url? string -
- html_url? string -
- body string -
- diff_hunk? string -
- path? string -
- position? int -
- original_position? int -
- commit_id? string -
- original_commit_id? string -
- user User -
- created_at? string -
- updated_at? string -
- side? string -
- start_side? string -
trigger.github: PullRequestReviewCommentEvent
Fields
- action string -
- comment PullRequestReviewComment -
- pull_request PullRequest -
- changes? record {} - For edited events, the changes to the comment
- sender User -
- repository Repository -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: PullRequestReviewEvent
Fields
- action string -
- review PullRequestReview -
- pull_request PullRequest -
- changes? record {} - For edited events, the changes to the review
- sender User -
- repository Repository -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: PullRequestReviewThreadEvent
Fields
- action string -
- pull_request PullRequest -
- thread record { node_id string, comments PullRequestReviewComment[] } - The review thread that was resolved or unresolved
- updated_at? string -
- sender? User -
- repository? Repository -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: PushEvent
Fields
- ref string - The full git ref that was pushed (e.g. refs/heads/main or refs/tags/v3.14.1)
- before string - The SHA of the most recent commit on ref before the push
- after string - The SHA of the most recent commit on ref after the push
- base_ref? string - The base ref for the push (if applicable)
- created boolean - Whether this push created the ref
- deleted boolean - Whether this push deleted the ref
- forced boolean - Whether this push was a force push of the ref
- compare string - URL showing the changes in this ref update
- commits Commit[] - Array of commit objects (maximum 2048)
- head_commit? Commit -
- pusher CommitAuthor - Metaproperties for the Git author/committer
- sender User -
- repository Repository -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: RegistryPackageEvent
Fields
- action string -
- registry_package record { id int, name string, namespace string, description string, ecosystem string, package_type string, html_url string, created_at string, updated_at string, owner User, package_version record { id int, 'version string, summary string, html_url string, target_commitish string, target_oid string, draft boolean, prerelease boolean, created_at string, updated_at string, package_files record { download_url string, id int, name string, 'sha256 string, content_type string, size int, created_at string, updated_at string }[], author User, installation_command string }, registry record { about_url string, name string, 'type string, url string, vendor string } } - The registry package object
- sender? User -
- repository? Repository -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: Release
Fields
- id int -
- node_id? string -
- url? string -
- html_url? string -
- assets_url? string -
- upload_url? string -
- tag_name string -
- name string -
- body? string -
- draft? boolean -
- prerelease? boolean -
- target_commitish? string -
- assets? record {}[] -
- created_at? string -
- published_at? string -
trigger.github: ReleaseEvent
Fields
- action string - The action that was performed
- release Release -
- changes? record {} - For edited events, the changes to the release
- sender User -
- repository Repository -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: Repository
Fields
- id int -
- node_id? string -
- name string - The repository name
- full_name string - The full repository name including owner (e.g. octocat/Hello-World)
- owner User -
- 'private boolean - Whether the repository is private
- html_url? string -
- description? string -
- 'fork? boolean -
- url? string -
- homepage? string -
- language? string -
- forks_count? int -
- stargazers_count? int -
- watchers_count? int -
- size? int -
- default_branch? string -
- open_issues_count? int -
- topics? string[] -
- has_issues? boolean -
- has_projects? boolean -
- has_wiki? boolean -
- has_pages? boolean -
- has_downloads? boolean -
- archived? boolean -
- disabled? boolean -
- visibility? string -
- pushed_at? string -
- created_at? string -
- updated_at? string -
trigger.github: RepositoryAdvisoryEvent
Fields
- action string -
- repository_advisory record { ghsa_id string, cve_id string, url string, html_url string, summary string, description string, severity string, author User, publisher User, identifiers record { 'type string, value string }[], state string, created_at string, updated_at string, published_at string, withdrawn_at string, submission record {}, vulnerabilities record { package record { ecosystem string, name string }, vulnerable_version_range string, patched_versions string, vulnerable_functions string[] }[], cvss record { vector_string string, score decimal }, cwes record { cwe_id string, name string }[], credits record { user User, 'type string }[] } - A repository security advisory
- sender? User -
- repository? Repository -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: RepositoryDispatchEvent
Fields
- action string - The event_type specified in the dispatch request body
- branch string - The branch from which the dispatch was triggered
- client_payload record {} - The client_payload from the dispatch request body
- installation? Installation -
- sender? User -
- repository? Repository -
- organization? Organization -
- enterprise? Enterprise -
trigger.github: RepositoryEvent
Fields
- action string -
- changes? record {} - For edited/renamed/transferred events, the changes that occurred
- repository? Repository -
- sender? User -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: RepositoryImportEvent
Fields
- status string - The final status of the import
- sender? User -
- repository? Repository -
- organization? Organization -
- installation? Installation -
trigger.github: RepositoryRulesetEvent
Fields
- action string -
- repository_ruleset record { id int, name string, target string, source_type string, 'source string, enforcement string, conditions record {}, rules record { 'type string, parameters record {} }[], bypass_actors record { actor_id int, actor_type string, bypass_mode string }[], created_at string, updated_at string } - A set of rules to apply when specified conditions are met
- changes? record {} - For edited events, the changes made to the ruleset
- sender? User -
- repository? Repository -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: RepositoryVulnerabilityAlertEvent
Fields
- action string -
- alert record { id int, affected_package_name string, affected_range string, fixed_in string, severity string, ghsa_id string, external_identifier string, external_reference string, created_at string, auto_dismissed_at string, dismiss_reason string, dismissed_at string, dismissed_by User, number int } - The security alert of the vulnerable dependency
- sender? User -
- repository? Repository -
- organization? Organization -
- installation? Installation -
trigger.github: SecretScanningAlertEvent
Fields
- action string -
- alert record { number int, created_at string, updated_at string, url string, html_url string, locations_url string, state string, resolution string, resolved_at string, resolved_by User, resolution_comment string, secret_type string, secret_type_display_name string, validity string, publicly_leaked boolean, multi_repo boolean, push_protection_bypassed boolean, push_protection_bypassed_by User, push_protection_bypassed_at string } - The secret scanning alert
- assignee? User - Present on assigned/unassigned actions
- sender? User -
- repository? Repository -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: SecretScanningAlertLocationEvent
Fields
- sender? User -
- repository? Repository -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: SecretScanningScanEvent
Fields
- 'type string - What type of scan was completed
- 'source string - What type of content was scanned
- started_at string - ISO 8601 timestamp when the scan started
- completed_at string - ISO 8601 timestamp when the scan completed
- secret_types? string[] - Patterns updated. Empty for normal backfill or custom pattern scans.
- custom_pattern_name? string - If triggered by a custom pattern update, the name of that pattern
- custom_pattern_scope? string - If triggered by a custom pattern update, the scope of that pattern
- sender? User -
- repository? Repository -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: SecurityAdvisoryEvent
Fields
- action string -
- security_advisory record { schema_version string, ghsa_id string, cve_id string, url string, html_url string, summary string, description string, severity string, identifiers record { value string, 'type string }[], references record { url string }[], published_at string, updated_at string, withdrawn_at string, vulnerabilities record { package record { ecosystem string, name string }, severity string, vulnerable_version_range string, first_patched_version record { identifier string } }[], cvss record { vector_string string, score decimal }, cwes record { cwe_id string, name string }[] } - The details of the global security advisory, including summary, description, severity, and affected packages.
- installation? Installation -
trigger.github: SecurityAndAnalysisEvent
Fields
- changes record { advanced_security record { 'from string, to string }, dependabot_alerts record { 'from string, to string }, dependabot_security_updates record { 'from string, to string }, secret_scanning record { 'from string, to string }, secret_scanning_push_protection record { 'from string, to string }, secret_scanning_non_provider_patterns record { 'from string, to string } } - The security and analysis settings that changed
- sender? User -
- repository? Repository -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: SponsorshipEvent
Fields
- action string -
- sponsorship record { node_id string, created_at string, privacy_level string, tier record { node_id string, created_at string, description string, monthly_price_in_cents int, monthly_price_in_dollars int, name string, is_one_time boolean, is_custom_amount boolean }, sponsor User, sponsorable User } - The sponsorship object
- changes? record { tier record { 'from record {} }, privacy_level record { 'from string } } - For edited, tier_changed, and pending_tier_change events
- effective_date? string - For pending_cancellation and pending_tier_change, the date the change takes effect (ISO 8601 date).
- sender? User -
- organization? Organization -
- installation? Installation -
trigger.github: StarEvent
Fields
- action string -
- starred_at string - The time the star was created (ISO 8601). Null for the deleted action.
- sender? User -
- repository? Repository -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: StatusEvent
Fields
- id int - The unique identifier of the status
- sha string - The commit SHA
- name string - The repository name
- state string - The new state of the commit status
- context string - The status context identifier
- description? string - The optional human-readable description
- target_url? string - The optional link added to the status
- avatar_url? string -
- created_at string -
- updated_at string -
- sender User -
- repository Repository -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: SubIssuesEvent
Fields
- action string -
- parent_issue_id int -
- parent_issue Issue -
- parent_issue_repo Repository -
- sub_issue_id int -
- sub_issue Issue -
- sender? User -
- repository? Repository -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: Team
Fields
- id int -
- node_id? string -
- name string -
- slug string -
- description? string -
- privacy? string -
- notification_setting? string -
- permission? string -
- url? string -
- html_url? string -
- members_url? string -
- repositories_url? string -
- parent? record {} -
trigger.github: TeamAddEvent
Fields
- team record { id int, node_id string, url string, html_url string, name string, slug string, description string, privacy string, notification_setting string, permission string, members_url string, repositories_url string, parent record { id int, node_id string, name string, slug string, description string, privacy string, permission string, members_url string, repositories_url string, html_url string } } - The team that was granted access to the repository
- sender? User -
- repository? Repository -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: TeamEvent
Fields
- action string -
- team Team -
- repository? Repository - Present for added_to_repository and removed_from_repository actions
- sender? User -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: User
Fields
- login string - The user's GitHub username
- id int - The user's unique numeric identifier
- node_id? string -
- avatar_url? string -
- gravatar_id? string -
- url? string -
- html_url? string -
- 'type? string -
- site_admin? boolean -
trigger.github: WatchEvent
Fields
- action string -
- sender User -
- repository Repository -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: WebhookHeaders
Fields
- xGitHubEvent string - The name of the event that triggered the delivery
- xGitHubDelivery string - A globally unique identifier (GUID) for this delivery
- xGitHubHookID int - The unique identifier of the webhook
- xGitHubHookInstallationTargetID? int - The unique identifier of the resource where the webhook was created
- xGitHubHookInstallationTargetType? string - The type of resource where the webhook was created
- xHubSignature? string - HMAC hex digest of the request body using SHA-1. Sent only when a webhook secret is configured. Use X-Hub-Signature-256 instead.
- xHubSignature256? string - HMAC hex digest of the request body using SHA-256. Sent only when a webhook secret is configured. Preferred over X-Hub-Signature.
- userAgent? string - Always has the prefix GitHub-Hookshot/
trigger.github: WorkflowDispatchEvent
Fields
- inputs? record {} - The inputs provided when manually triggering the workflow
- ref string - The branch or tag ref from which the workflow was triggered
- workflow string - The path to the workflow file (e.g. .github/workflows/main.yml)
- sender? User -
- repository? Repository -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: WorkflowJob
Fields
- id int -
- run_id? int -
- run_url? string -
- run_attempt? int -
- node_id? string -
- head_sha? string -
- url? string -
- html_url? string -
- status string -
- conclusion? string -
- created_at? string -
- started_at? string -
- completed_at? string -
- name string -
- check_run_url? string -
- labels? string[] -
- runner_id? int -
- runner_name? string -
- runner_group_id? int -
- runner_group_name? string -
- workflow_name? string -
- head_branch? string -
trigger.github: WorkflowJobEvent
Fields
- action string -
- workflow_job WorkflowJob -
- deployment? Deployment - The deployment associated with the workflow job (if applicable)
- sender? User -
- repository? Repository -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
trigger.github: WorkflowRun
Fields
- id int -
- name string -
- node_id? string -
- check_suite_id? int -
- check_suite_node_id? string -
- head_branch? string -
- head_sha? string -
- run_number? int -
- event? string -
- status string -
- conclusion? string -
- workflow_id? int -
- url? string -
- html_url? string -
- pull_requests? record {}[] -
- created_at? string -
- updated_at? string -
- run_attempt? int -
- run_started_at? string -
- actor? User -
- triggering_actor? User -
- jobs_url? string -
- logs_url? string -
- check_suite_url? string -
- artifacts_url? string -
- cancel_url? string -
- rerun_url? string -
- workflow_url? string -
- head_commit? Commit -
- repository? Repository -
trigger.github: WorkflowRunEvent
Fields
- action string -
- workflow_run WorkflowRun -
- sender? User -
- repository? Repository -
- organization? Organization -
- installation? Installation -
- enterprise? Enterprise -
Union types
trigger.github: GenericServiceType
GenericServiceType
trigger.github: GenericDataType
GenericDataType