Skip to content
Sign in

flagon-io/g1t

public
0

g1t/packages/contracts/src/webhooks.ts

145 lines4,062 bytesCodeBlame

Pick any line to see why it is the way it is: the commit, the pull request and issue it came from, and what the agent was thinking.

Webhooks: every event, to your own addresses, signed and retried1import type { User, Viewer } from "./identity";
2import type { RepoPath } from "./repos";
3import type { Result } from "./result";
4
5/**
6 * Events, delivered to the addresses a repository or a workspace registers.
7 * Mirrors `crates/contracts/src/webhooks.rs`.
8 */
9
10/** Every event a webhook can be sent, in the order people are shown them. */
11export const EVENT_TYPES = [
12 "git.push",
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look13 "branch.renamed",
Webhooks: every event, to your own addresses, signed and retried14 "repo.created",
15 "repo.forked",
Invite-only launch: sign in with GitHub, repository access and lifecycle, many emails, a new look16 "repo.updated",
17 "repo.visibility_changed",
18 "repo.renamed",
19 "repo.transferred",
20 "repo.default_branch_changed",
21 "repo.archived",
22 "repo.unarchived",
23 "repo.deleted",
24 "repo.restored",
25 "repo.purged",
26 "repo.collaborator_added",
27 "repo.collaborator_removed",
28 "repo.collaborator_role_changed",
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar29 "team.created",
30 "team.edited",
31 "team.deleted",
32 "team.member_added",
33 "team.member_role_changed",
34 "team.member_removed",
35 "team.repo_added",
36 "team.repo_role_changed",
37 "team.repo_removed",
Merge rulesets: branch and tag rules, agent-first, enforced on push and merge38 "ruleset.created",
39 "ruleset.updated",
40 "ruleset.deleted",
Webhooks: every event, to your own addresses, signed and retried41 "issue.opened",
42 "issue.updated",
43 "issue.assigned",
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar44 "issue.labeled",
45 "issue.unlabeled",
46 "issue.milestoned",
47 "issue.demilestoned",
Webhooks: every event, to your own addresses, signed and retried48 "issue.closed",
49 "issue.reopened",
50 "comment.created",
51 "pull.opened",
52 "pull.ready",
53 "pull.updated",
54 "pull.merge_requested",
55 "pull.merged",
56 "pull.closed",
Events: review requests, assignments, stops and deployments are published57 "pull.assigned",
58 "pull.review_requested",
59 "pull.review_request_removed",
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar60 "pull.labeled",
61 "pull.unlabeled",
62 "pull.milestoned",
63 "pull.demilestoned",
64 "pull.base_changed",
Events: review requests, assignments, stops and deployments are published65 "pull.stalled",
66 "pull.resumed",
Agents asked while not at work are woken to answer67 "agent.asked",
Webhooks: every event, to your own addresses, signed and retried68 "checks.completed",
69 "review.completed",
Actions: workflow_run, workflow.completed, artifacts on the run page, Node 2470 "workflow.completed",
Events: review requests, assignments, stops and deployments are published71 "deployment.succeeded",
72 "deployment.failed",
Webhooks: every event, to your own addresses, signed and retried73 "queue.changed",
74 "session.appended",
Packages, with a container registry on g1t.sh; workspaces deleted whole and kept 30 days; Members for every member75 "package.published",
76 "package.version_deleted",
77 "package.deleted",
78 "package.visibility_changed",
Teams and CODEOWNERS, labels and milestones, dependency updates, the security suite, and a clearer top bar79 "secret_scanning_alert.created",
80 "secret_scanning_alert.fixed",
81 "secret_scanning_alert.dismissed",
82 "secret_scanning_alert.reopened",
83 "secret_scanning.bypass_requested",
84 "secret_scanning.bypass_reviewed",
85 "code_scanning_alert.created",
86 "code_scanning_alert.fixed",
87 "code_scanning_alert.dismissed",
88 "code_scanning_alert.reopened",
89 "vulnerability_alert.created",
90 "vulnerability_alert.fixed",
91 "vulnerability_alert.dismissed",
92 "vulnerability_alert.reopened",
Webhooks: every event, to your own addresses, signed and retried93] as const;
94
95export type Hook = {
96 id: string;
97 scope: "repo" | "workspace";
98 workspace: string;
99 /** For a repository's webhook: `owner/name`. */
100 repo: string | null;
101 url: string;
102 /** Event types, or `["*"]` for all. */
103 events: string[];
104 active: boolean;
105 secretHint: string;
106 createdBy: string;
107 createdAt: string;
108 lastStatus: "delivered" | "pending" | "failed" | null;
109 lastDeliveredAt: string | null;
110};
111
112export type HookDelivery = {
113 id: string;
114 hookId: string;
115 eventId: string;
116 event: string;
117 status: "pending" | "delivered" | "failed";
118 attempts: number;
119 responseStatus: number | null;
120 responseBody: string | null;
121 error: string | null;
122 durationMs: number | null;
123 /** The JSON that was sent. */
124 payload: string;
125 createdAt: string;
126 deliveredAt: string | null;
127 nextAttemptAt: string | null;
128};
129
130/** A repository's webhooks, or with `repo` left out, the workspace's own. */
131export type HookOwner = { workspace: string; repo?: RepoPath };
132
133export interface WebhooksApi {
134 list(viewer: Viewer, owner: HookOwner): Promise<Result<Hook[]>>;
135 create(
136 actor: User,
137 owner: HookOwner,
138 input: { url: string; events?: string[]; secret?: string },
139 ): Promise<Result<{ hook: Hook; secret: string | null }>>;
140 update(actor: User, owner: HookOwner, id: string, input: { url?: string; events?: string[]; active?: boolean }): Promise<Result<Hook>>;
141 delete(actor: User, owner: HookOwner, id: string): Promise<Result<boolean>>;
142 ping(actor: User, owner: HookOwner, id: string): Promise<Result<HookDelivery>>;
143 deliveries(viewer: Viewer, owner: HookOwner, id: string): Promise<Result<HookDelivery[]>>;
144 redeliver(actor: User, owner: HookOwner, deliveryId: string): Promise<Result<HookDelivery>>;
145}

This file's history is long; its oldest lines are credited to the oldest commit read.