@octokit/webhooks-types

Octokit Webhooks

machine-readable, always up-to-date GitHub Webhooks specifications

Download

Download the latest specification at octokit.github.io/webhooks/payload-examples/api.github.com/index.json

Usage

This package ships with types for the webhook events generated from the respective json schemas, which you can use like so:

import { WebhookEvent, IssuesOpenedEvent } from "@octokit/webhooks-types";

const handleWebhookEvent = (event: WebhookEvent) => {
  if ("action" in event && event.action === "completed") {
    console.log(`${event.sender.login} completed something!`);
  }
};

const handleIssuesOpenedEvent = (event: IssuesOpenedEvent) => {
  console.log(
    `${event.sender.login} opened "${event.issue.title}" on ${event.repository.full_name}`,
  );
};

Caution : Webhooks Types are expected to be used with the strictNullChecks option enabled in your tsconfig. If you don't have this option enabled, there's the possibility that you get never as the inferred type in some use cases. See #395 for details.

See also

• octokit/graphql-schema – GitHub’s GraphQL Schema with validation
• octokit/openapi – GitHub REST API route specifications
• octokit/app-permissions – GitHub App permission specifications

LICENSE

MIT