GitHub Issue (github_issue_v1)

Replicate GitHub Issues into your database.

To get set up, run this code from the WebhookDB CLI:

webhookdb integrations create github_issue_v1

Source documentation for this API: https://docs.github.com/en/rest/issues/issues?apiVersion=2022-11-28

Features

Supports Webhooks
✅
Supports Backfilling
✅

Schema

Tables replicated from GitHub Issues have this schema. Note that the data types listed are for Postgres; when replicating to other databases, other data types maybe used.

Column Type Indexed
pk bigint  
github_id bigint  
node_id text ✅
number integer ✅
state text  
user_id bigint ✅
closed_by_id bigint ✅
assignee_ids bigint[] ✅
milestone_number integer  
label_ids bigint[]  
created_at timestamptz ✅
closed_at timestamptz ✅
updated_at timestamptz ✅
data* jsonb  

* The data column contains the raw payload from the webhook or API. In many cases there is no canonical form, like if a webhook and API request return two different versions of the same resource. In that case we try to keep the most coherent and detailed resource.”

Table definition

This definition can also be generated through webhookdb fixture github_issue_v1.

CREATE TABLE public.github_issue_v1_fixture (
  pk bigserial PRIMARY KEY,
  github_id bigint UNIQUE NOT NULL,
  node_id text,
  number integer,
  state text,
  user_id bigint,
  closed_by_id bigint,
  assignee_ids bigint[],
  milestone_number integer,
  label_ids bigint[],
  created_at timestamptz,
  closed_at timestamptz,
  updated_at timestamptz,
  data jsonb NOT NULL
);
CREATE INDEX IF NOT EXISTS svi_fixture_node_id_idx ON public.github_issue_v1_fixture (node_id);
CREATE INDEX IF NOT EXISTS svi_fixture_number_idx ON public.github_issue_v1_fixture (number);
CREATE INDEX IF NOT EXISTS svi_fixture_user_id_idx ON public.github_issue_v1_fixture (user_id);
CREATE INDEX IF NOT EXISTS svi_fixture_closed_by_id_idx ON public.github_issue_v1_fixture (closed_by_id);
CREATE INDEX IF NOT EXISTS svi_fixture_assignee_ids_idx ON public.github_issue_v1_fixture (assignee_ids);
CREATE INDEX IF NOT EXISTS svi_fixture_created_at_idx ON public.github_issue_v1_fixture (created_at);
CREATE INDEX IF NOT EXISTS svi_fixture_closed_at_idx ON public.github_issue_v1_fixture (closed_at);
CREATE INDEX IF NOT EXISTS svi_fixture_updated_at_idx ON public.github_issue_v1_fixture (updated_at);
← github_issue_comment_v1github_pull_v1 →