| Copyright | (c) ONROCK 2018 |
|---|---|
| License | MIT |
| Maintainer | Kyle Van Berendonck <foss@onrock.online> |
| Safe Haskell | Trustworthy |
| Language | Haskell2010 |
GitHub.Data.Webhooks.Events
Description
This module contains types that represent GitHub webhook's events.
Synopsis
- class EventHasSender eventKind where
- senderOfEvent :: eventKind -> HookUser
- class EventHasRepo eventKind where
- repoForEvent :: eventKind -> HookRepository
- data CommitCommentEvent = CommitCommentEvent {}
- data CommitCommentEventAction
- data CreateEvent = CreateEvent {}
- data DeleteEvent = DeleteEvent {}
- data DeploymentEvent = DeploymentEvent {}
- data DeploymentStatusEvent = DeploymentStatusEvent {}
- data DownloadEvent = DownloadEvent
- data FollowEvent = FollowEvent
- data ForkEvent = ForkEvent {}
- data ForkApplyEvent = ForkApplyEvent
- data GistEvent = GistEvent
- data GollumEvent = GollumEvent {}
- data InstallationEvent = InstallationEvent {}
- data InstallationEventAction
- data InstallationRepositoriesEvent = InstallationRepositoriesEvent {}
- data InstallationRepoEventAction
- data IssueCommentEvent = IssueCommentEvent {}
- data IssueCommentEventAction
- data IssuesEvent = IssuesEvent {}
- data IssuesEventAction
- data LabelEvent = LabelEvent {}
- data LabelEventAction
- data MemberEvent = MemberEvent {}
- data MemberEventAction
- data MembershipEvent = MembershipEvent {}
- data MembershipEventAction
- data MilestoneEvent = MilestoneEvent {}
- data MilestoneEventAction
- data OrganizationEvent = OrganizationEvent {}
- data OrganizationEventAction
- data OrgBlockEvent = OrgBlockEvent {}
- data OrgBlockEventAction
- data PageBuildEvent = PageBuildEvent {}
- data ProjectCardEvent = ProjectCardEvent {}
- data ProjectCardEventAction
- data ProjectColumnEvent = ProjectColumnEvent {}
- data ProjectColumnEventAction
- data ProjectEvent = ProjectEvent {}
- data ProjectEventAction
- data PublicEvent = PublicEvent {}
- data PullRequestEvent = PullRequestEvent {}
- data PullRequestEventAction
- = PullRequestAssignedAction
- | PullRequestUnassignedAction
- | PullRequestReviewRequestedAction
- | PullRequestReviewRequestRemovedAction
- | PullRequestLabeledAction
- | PullRequestUnlabeledAction
- | PullRequestOpenedAction
- | PullRequestEditedAction
- | PullRequestClosedAction
- | PullRequestReopenedAction
- | PullRequestActionOther !Text
- data PullRequestReviewEvent = PullRequestReviewEvent {}
- data PullRequestReviewEventAction
- data PullRequestReviewCommentEvent = PullRequestReviewCommentEvent {}
- data PullRequestReviewCommentEventAction
- data PushEvent = PushEvent {
- evPushRef :: !Text
- evPushHeadSha :: !(Maybe Text)
- evPushBeforeSha :: !(Maybe Text)
- evPushCreated :: !Bool
- evPushDeleted :: !Bool
- evPushForced :: !Bool
- evPushBaseRef :: !(Maybe Text)
- evPushCompareUrl :: !URL
- evPushCommits :: !(Maybe (Vector HookCommit))
- evPushHeadCommit :: !(Maybe HookCommit)
- evPushRepository :: !HookRepository
- evPushOrganization :: !(Maybe HookOrganization)
- evPushSender :: !HookUser
- data ReleaseEvent = ReleaseEvent {}
- data ReleaseEventAction
- data RepositoryEvent = RepositoryEvent {}
- data RepositoryEventAction
- data StatusEvent = StatusEvent {
- evStatusId :: !Int
- evStatusCommitSha :: !Text
- evStatusCommitName :: !Text
- evStatusTargetUrl :: !(Maybe URL)
- evStatusContext :: !Text
- evStatusDescription :: !(Maybe Text)
- evStatusState :: !StatusEventState
- evStatusCommit :: !HookCommit
- evStatusCreatedAt :: !UTCTime
- evStatusUpdatedAt :: !UTCTime
- evStatusRepo :: !HookRepository
- evStatusSender :: !HookUser
- data StatusEventState
- data TeamEvent = TeamEvent {}
- data TeamEventAction
- data TeamAddEvent = TeamAddEvent {}
- data WatchEvent = WatchEvent {}
- data WatchEventAction
Documentation
class EventHasSender eventKind where #
Represents an event that contains its sender information.
Instances
class EventHasRepo eventKind where #
Represents an event that contains its repository information.
Methods
repoForEvent :: eventKind -> HookRepository #
Provides the repository context of a Webhook event.
Instances
data CommitCommentEvent #
Triggered when a commit comment is created. See https://developer.github.com/v3/activity/events/types/#commitcommentevent.
Constructors
| CommitCommentEvent | |
Instances
data CommitCommentEventAction #
Represents the "action" field in the
CommitCommentEvent payload.
Constructors
| CommitCommentActionCreated | Decodes from "created" |
| CommitCommentActionOther !Text | The result of decoding an unknown commit comment event action type |
Instances
data CreateEvent #
Represents a created repository, branch, or tag. Note: webhooks will not receive this event for created repositories. Additionally, webhooks will not receive this event for tags if more than three tags are pushed at once. See https://developer.github.com/v3/activity/events/types/#createevent.
Constructors
| CreateEvent | |
Fields
| |
Instances
data DeleteEvent #
Represents a deleted branch or tag. Note: webhooks will not receive this event for tags if more than three tags are deleted at once. See https://developer.github.com/v3/activity/events/types/#deleteevent.
Constructors
| DeleteEvent | |
Fields
| |
Instances
data DeploymentEvent #
Represents a deployment. Events of this type are not visible in timelines. These events are only used to trigger hooks. See https://developer.github.com/v3/activity/events/types/#deploymentevent.
Constructors
| DeploymentEvent | |
Fields | |
Instances
data DeploymentStatusEvent #
Represents a deployment status. Events of this type are not visible in timelines. These events are only used to trigger hooks. See https://developer.github.com/v3/activity/events/types/#deploymentstatusevent.
Constructors
| DeploymentStatusEvent | |
Instances
data DownloadEvent #
Triggered when a new download is created. Events of this kind are no longer delivered. See https://developer.github.com/v3/activity/events/types/#downloadevent.
Constructors
| DownloadEvent |
data FollowEvent #
Triggered when a user follows another user. Events of this kind are no longer delivered. See https://developer.github.com/v3/activity/events/types/#downloadevent.
Constructors
| FollowEvent |
Triggered when a user forks a repository. See https://developer.github.com/v3/activity/events/types/#forkevent.
Constructors
| ForkEvent | |
Fields | |
Instances
data ForkApplyEvent #
Triggered when a patch is applied in the Fork Queue. Events of this kind are no longer delivered. See https://developer.github.com/v3/activity/events/types/#forkapplyevent.
Constructors
| ForkApplyEvent |
Triggered when a Gist is created or updated. Events of this kind are no longer delivered. See https://developer.github.com/v3/activity/events/types/#gistevent.
Constructors
| GistEvent |
data GollumEvent #
Triggered when a Wiki page is created or updated. See https://developer.github.com/v3/activity/events/types/#gollumevent.
Constructors
| GollumEvent | |
Fields
| |
Instances
data InstallationEvent #
Triggered when a GitHub App has been installed or uninstalled. See https://developer.github.com/v3/activity/events/types/#installationevent.
Constructors
| InstallationEvent | |
Instances
data InstallationEventAction #
Constructors
| InstallationCreatedAction | Decodes from "created" |
| InstallationDeletedAction | Decodes from "deleted" |
| InstallationActionOther !Text | The result of decoding an unknown installation event action type |
Instances
data InstallationRepositoriesEvent #
Triggered when a repository is added or removed from an installation. See https://developer.github.com/v3/activity/events/types/#installationrepositoriesevent.
Constructors
| InstallationRepositoriesEvent | |
Instances
data InstallationRepoEventAction #
Constructors
| InstallationRepoCreatedAction | Decodes from "created" |
| InstallationRepoRemovedAction | Decodes from "removed" |
| InstallationRepoActionOther !Text | The result of decoding an unknown installation repo event action type |
Instances
data IssueCommentEvent #
Triggered when an issue comment is created, edited, or deleted. See https://developer.github.com/v3/activity/events/types/#issuecommentevent.
Constructors
| IssueCommentEvent | |
Instances
data IssueCommentEventAction #
Constructors
| IssueCommentCreatedAction | Decodes from "created" |
| IssueCommentEditedAction | Decodes from "edited" |
| IssueCommentDeletedAction | Decodes from "deleted" |
| IssueCommentActionOther !Text | The result of decoding an unknown issue comment event action type |
Instances
data IssuesEvent #
Triggered when an issue is assigned, unassigned, labeled, unlabeled, opened, edited, milestoned, demilestoned, closed, or reopened. See https://developer.github.com/v3/activity/events/types/#issuesevent.
Constructors
| IssuesEvent | |
Instances
data IssuesEventAction #
Constructors
| IssuesAssignedAction | Decodes from "assigned" |
| IssuesUnassignedAction | Decodes from "unassigned" |
| IssuesLabeledAction | Decodes from "labeled" |
| IssuesUnlabeledAction | Decodes from "unlabeled" |
| IssuesOpenedAction | Decodes from "opened" |
| IssuesEditedAction | Decodes from "edited" |
| IssuesMilestonedAction | Decodes from "milestoned" |
| IssuesDemilestonedAction | Decodes from "demilestoned" |
| IssuesClosedAction | Decodes from "closed" |
| IssuesReopenedAction | Decodes from "reopened" |
| IssuesActionOther !Text | The result of decoding an unknown issue comment event action type |
Instances
data LabelEvent #
Triggered when a repository's label is created, edited, or deleted. Events of this type are not visible in timelines. These events are only used to trigger hooks. See https://developer.github.com/v3/activity/events/types/#labelevent.
Constructors
| LabelEvent | |
Instances
data LabelEventAction #
Constructors
| LabelCreatedAction | Decodes from "created" |
| LabelEditedAction | Decodes from "edited" |
| LabelDeletedAction | Decodes from "deleted" |
| LabelActionOther !Text | The result of decoding an unknown label event action type |
Instances
data MemberEvent #
Triggered when a user is added or removed as a collaborator to a repository, or has their permissions changed. See https://developer.github.com/v3/activity/events/types/#memberevent.
Constructors
| MemberEvent | |
Fields | |
Instances
data MemberEventAction #
Constructors
| MemberAddedAction | Decodes from "added" |
| MemberEditedAction | Decodes from "edited" |
| MemberDeletedAction | Decodes from "deleted" |
| MemberActionOther !Text | The result of decoding an unknown label event action type |
Instances
data MembershipEvent #
Triggered when a user is added or removed from a team. Events of this type are not visible in timelines. These events are only used to trigger hooks. See https://developer.github.com/v3/activity/events/types/#membershipevent.
Constructors
| MembershipEvent | |
Fields
| |
Instances
data MembershipEventAction #
Constructors
| MembershipAddedAction | Decodes from "added" |
| MembershipRemovedAction | Decodes from "removed" |
| MembershipActionOther !Text | The result of decoding an unknown label event action type |
Instances
data MilestoneEvent #
Triggered when a milestone is created, closed, opened, edited, or deleted. Events of this type are not visible in timelines. These events are only used to trigger hooks. See https://developer.github.com/v3/activity/events/types/#milestoneevent.
Constructors
| MilestoneEvent | |
Instances
data MilestoneEventAction #
Constructors
| MilestoneCreatedAction | Decodes from "created" |
| MilestoneClosedAction | Decodes from "closed" |
| MilestoneOpenedAction | Decodes from "opened" |
| MilestoneEditedAction | Decodes from "edited" |
| MilestoneDeletedAction | Decodes from "deleted" |
| MilestoneActionOther !Text | The result of decoding an unknown label event action type |
Instances
data OrganizationEvent #
Triggered when a user is added, removed, or invited to an Organization. Events of this type are not visible in timelines. These events are only used to trigger organization hooks. See https://developer.github.com/v3/activity/events/types/#organizationevent.
Constructors
| OrganizationEvent | |
Instances
data OrganizationEventAction #
Constructors
| OrgMemberAddedAction | Decodes from "member_added" |
| OrgMemberRemovedAction | Decodes from "member_removed" |
| OrgMemberInvitedAction | Decodes from "member_invited" |
| OrgActionOther !Text | The result of decoding an unknown label event action type |
Instances
data OrgBlockEvent #
Triggered when an organization blocks or unblocks a user. See https://developer.github.com/v3/activity/events/types/#orgblockevent.
Constructors
| OrgBlockEvent | |
Fields | |
Instances
data OrgBlockEventAction #
Constructors
| OrgBlockBlockedAction | Decodes from "blocked" |
| OrgBlockUnblockedAction | Decodes from "unblocked" |
| OrgBlockActionOther !Text | The result of decoding an unknown org block event action type |
Instances
data PageBuildEvent #
Represents an attempted build of a GitHub Pages site, whether successful or not. Triggered on push to a GitHub Pages enabled branch (gh-pages for project pages, master for user and organization pages). Events of this type are not visible in timelines. These events are only used to trigger hooks. See https://developer.github.com/v3/activity/events/types/#pagebuildevent.
Constructors
| PageBuildEvent | |
Fields | |
Instances
data ProjectCardEvent #
Triggered when a project card is created, updated, moved, converted to an issue, or deleted. See https://developer.github.com/v3/activity/events/types/#projectcardevent.
Constructors
| ProjectCardEvent | |
Instances
data ProjectCardEventAction #
Constructors
| ProjectCardCreatedAction | Decodes from "created" |
| ProjectCardEditedAction | Decodes from "edited" |
| ProjectCardConvertedAction | Decodes from "converted" |
| ProjectCardMovedAction | Decodes from "moved" |
| ProjectCardDeletedAction | Decodes from "deleted" |
| ProjectCardActionOther !Text | The result of decoding an unknown project card event action type |
Instances
data ProjectColumnEvent #
Triggered when a project column is created, updated, moved, or deleted. See https://developer.github.com/v3/activity/events/types/#projectcolumnevent.
Constructors
| ProjectColumnEvent | |
Instances
data ProjectColumnEventAction #
Constructors
| ProjectColumnCreatedAction | Decodes from "created" |
| ProjectColumnEditedAction | Decodes from "edited" |
| ProjectColumnMovedAction | Decodes from "moved" |
| ProjectColumnDeletedAction | Decodes from "deleted" |
| ProjectColumnActionOther !Text | The result of decoding an unknown project card event action type |
Instances
data ProjectEvent #
Triggered when a project is created, updated, closed, reopened, or deleted. See https://developer.github.com/v3/activity/events/types/#projectevent.
Constructors
| ProjectEvent | |
Instances
data ProjectEventAction #
Constructors
| ProjectCreatedAction | Decodes from "created" |
| ProjectEditedAction | Decodes from "edited" |
| ProjectClosedAction | Decodes from "closed" |
| ProjectReopenedAction | Decodes from "reopened" |
| ProjectDeletedAction | Decodes from "deleted" |
| ProjectActionOther !Text | The result of decoding an unknown project event action type |
Instances
data PublicEvent #
Triggered when a private repository is open sourced. Without a doubt: the best GitHub event. See https://developer.github.com/v3/activity/events/types/#publicevent.
Constructors
| PublicEvent | |
Fields | |
Instances
data PullRequestEvent #
Triggered when a pull request is assigned, unassigned, labeled, unlabeled, opened, edited, closed, reopened, or synchronized. Also triggered when a pull request review is requested, or when a review request is removed. See https://developer.github.com/v3/activity/events/types/#pullrequestevent.
Constructors
| PullRequestEvent | |
Fields | |
Instances
data PullRequestEventAction #
Constructors
| PullRequestAssignedAction | Decodes from "assigned" |
| PullRequestUnassignedAction | Decodes from "unassigned" |
| PullRequestReviewRequestedAction | Decodes from "review_requsted" |
| PullRequestReviewRequestRemovedAction | Decodes from "review_request_removed" |
| PullRequestLabeledAction | Decodes from "labeled" |
| PullRequestUnlabeledAction | Decodes from "unlabeled" |
| PullRequestOpenedAction | Decodes from "opened" |
| PullRequestEditedAction | Decodes from "edited" |
| PullRequestClosedAction | Decodes from "closed" |
| PullRequestReopenedAction | Decodes from "reopened" |
| PullRequestActionOther !Text | The result of decoding an unknown pull request event action type |
Instances
data PullRequestReviewEvent #
Triggered when a pull request review is submitted into a non-pending state, the body is edited, or the review is dismissed. See https://developer.github.com/v3/activity/events/types/#pullrequestreviewevent.
Constructors
| PullRequestReviewEvent | |
Instances
data PullRequestReviewEventAction #
Constructors
| PullRequestReviewSubmittedAction | Decodes from "submitted" |
| PullRequestReviewEditedAction | Decodes from "edited" |
| PullRequestReviewDismissedAction | Decodes from "dismissed" |
| PullRequestReviewActionOther !Text | The result of decoding an unknown pull request review event action type |
Instances
data PullRequestReviewCommentEvent #
Triggered when a comment on a pull request's unified diff is created, edited, or deleted (in the Files Changed tab). See https://developer.github.com/v3/activity/events/types/#pullrequestreviewcommentevent.
Constructors
| PullRequestReviewCommentEvent | |
Instances
data PullRequestReviewCommentEventAction #
Constructors
| PullRequestReviewCommentCreatedAction | Decodes from "created" |
| PullRequestReviewCommentEditedAction | Decodes from "edited" |
| PullRequestReviewCommentDeletedAction | Decodes from "deleted" |
| PullRequestReviewCommentActionOther !Text | The result of decoding an unknown pull request review comment event action type |
Instances
Triggered on a push to a repository branch. Branch pushes and repository tag pushes also trigger webhook push events. See https://developer.github.com/v3/activity/events/types/#pushevent.
Constructors
| PushEvent | |
Fields
| |
Instances
data ReleaseEvent #
Triggered when a release is published. See https://developer.github.com/v3/activity/events/types/#releaseevent.
Constructors
| ReleaseEvent | |
Fields
| |
Instances
data ReleaseEventAction #
Constructors
| ReleasePublishedAction | Decodes from "published" |
| ReleaseActionOther !Text | The result of decoding an unknown release event action type |
Instances
data RepositoryEvent #
Triggered when a repository is created, archived, unarchived, made public, or made private. Organization hooks are also triggered when a repository is deleted. Events of this type are not visible in timelines. These events are only used to trigger hooks. See https://developer.github.com/v3/activity/events/types/#repositoryevent.
Constructors
| RepositoryEvent | |
Instances
data RepositoryEventAction #
Constructors
| RepositoryCreatedAction | Decodes from "created" |
| RepositoryDeletedAction | Decodes from "deleted" |
| RepositoryArchivedAction | Decodes from "archived" |
| RepositoryUnarchivedAction | Decodes from "unarchived" |
| RepositoryPublicizedAction | Decodes from "publicized" |
| RepositoryPrivatizedAction | Decodes from "privatized" |
| RepositoryActionOther !Text | The result of decoding an unknown repository event action type |
Instances
data StatusEvent #
Triggered when the status of a Git commit changes. Events of this type are not visible in timelines. These events are only used to trigger hooks. See https://developer.github.com/v3/activity/events/types/#statusevent.
Constructors
| StatusEvent | |
Fields
| |
Instances
data StatusEventState #
Constructors
| StatusPendingState | Decodes from "pending" |
| StatusSuccessState | Decodes from "success" |
| StatusFailureState | Decodes from "failure" |
| StatusErrorState | Decodes from "error" |
| StatusStateOther !Text | The result of decoding an unknown status event state |
Instances
Triggered when an organization's team is created or deleted. Events of this type are not visible in timelines. These events are only used to trigger organization hooks. See https://developer.github.com/v3/activity/events/types/#teamevent.
Constructors
| TeamEvent | |
Fields | |
Instances
data TeamEventAction #
Constructors
| TeamCreatedAction | Decodes from "created" |
| TeamDeletedAction | Decodes from "deleted" |
| TeamEditedAction | Decodes from "edited" |
| TeamAddedToRepoAction | Decodes from "added_to_repository" |
| TeamRemovedFromRepoAction | Decodes from "removed_from_repository" |
| TeamActionOther !Text | The result of decoding an unknown team event action type |
Instances
data TeamAddEvent #
Triggered when a repository is added to a team. Events of this type are not visible in timelines. These events are only used to trigger hooks. See https://developer.github.com/v3/activity/events/types/#teamaddevent.
Constructors
| TeamAddEvent | |
Fields
| |
Instances
data WatchEvent #
The WatchEvent is related to starring a repository, not watching. The event’s actor is the user who starred a repository, and the event’s repository is the repository that was starred. See https://developer.github.com/v3/activity/events/types/#watchevent.
Constructors
| WatchEvent | |
Fields | |
Instances
data WatchEventAction #
Constructors
| WatchStartedAction | Decodes from "started" |
| WatchActionOther !Text | The result of decoding an unknown watch event action type |