⭐ START HERE: Category Resource Guide for API & Webhooks 📚

[ghostinhershell]

Have a question for the community? Our Category Resource Guide may have the answer that you’re looking for, or may be able to point you in the right direction!

🌟 Getting Started with GitHub’s API

New to GitHub’s API? These resources will help you get started:

REST API Resources

REST is commonly regarded as the standard for designing web APIs. To learn more about creating integrations, retrieving data, automating your workflows, and building with the GitHub REST API, click here.

• Quickstart Guide for using GitHub’s REST API
• REST API Guides - This guide will go over everything you need to know, from authentication to results manipulation to integrating results with other apps. Every tutorial will include a project, and each project will be saved and documented in our public platform-samples repository.
• Best practices for using the REST API
• Authenticating to the REST API
• Learn how to resolve the most common problems people encounter in the REST API here.

Personal Access Tokens (PATs)

Personal access tokens are an alternative to using passwords for authentication to GitHub when using the GitHub API or the command line.

• Learn more about how you can use the REST API to manage fine-grained personal access tokens here.
• Managing your personal access tokens
• Endpoints available for fine-grained personal access tokens
• Permissions required for fine-grained personal access tokens

Note 1: Personal access tokens are intended to access GitHub resources on behalf of yourself. To access resources on behalf of an organization, or for long-lived integrations, you should use a GitHub App instead. For more information, see our resources on Using GitHub apps below.

Note 2: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change.

GraphQL API Resources

The GitHub GraphQL API offers more precise and flexible queries than the GitHub REST API. To learn more about creating integrations, retrieving data, and automating your workflows using the GitHub GraphQL API, click here or check out the resources below:

• Introduction to GraphQL
• Forming calls with GraphQL
• GraphQL Global Node IDs
  • Using global node IDs
  • Migrating GraphQL global node IDs
• Migrating from REST to GraphQL
• Resource Limitations
• Changelog

Webhooks Resources

Webhooks can let your integrations take an action in response to events that occur on GitHub. You can set up, test, and secure webhooks so your integrations can subscribe and react to webhook events on GitHub. Learn where to start, what’s new and what’s popular here.

• Creating Webhooks
• Webhook events and payloads
• Webhook Deliveries
  • Viewing webhook deliveries
  • Handling webhook deliveries
  • Handling failed webhook deliveries
• Best practices for using webhooks
• Testing your Webhooks
• Testing and troubleshooting webhooks
• Disabling Webhooks

Integrating with Jira, ZenDesk and other external apps

• Featured GitHub integrations: Use GitHub extensions to work seamlessly in repositories on GitHub.com within third-party applications.
• The Jira and GitHub integration synchronizes development across tools and uses automation to remove manual steps and shorten delivery time.
• Click here to learn more about how to add autolinks to external resources like JIRA issues and Zendesk tickets to help bring data from those apps into your GH PRs ad issues, and help streamline your workflow.
• Integrate Jira Software with GitHub Cloud
• Integrating Jira with GitHub Enterprise Server

How Do I Check My Rate Limit?

• Read up on the feature and find any associated endpoints
  • Overview - Rate limiting will explain rate limits at a high-level
• If the endpoint exists, create an example curl request to perform that action
  • The Rate Limit API doc documents the endpoint for checking the authenticated user's current rate limit status
• The GraphQL API also has a custom rate limit that is separate from and calculated differently than rate limits in the REST API. For more information, see our Resource limitations doc.
• Consider using conditional requests to help you stay within the rate limit. For more information about conditional requests, see our Resources in the REST API doc.
• If possible, consider using consolidated GraphQL queries instead of REST API requests to help you stay within rate limits. For more information, see "About GitHub's APIs" and "GitHub GraphQL API documentation."

Note: If you hit a rate limit, you should stop making requests until after the time specified by the x-ratelimit-reset header. Failure to do so may result in the banning of your integration.

🗣️ Authenticating with OAuth apps and GitHub Apps

Using OAuth Apps

• Creating an OAuth app
  • Best practices for creating an OAuth app
• Building OAuth apps
  • Authorizing OAuth apps
• Deleting an OAuth app
• Rate limits for OAuth apps

When obtaining an OAuth token for a user, some errors may occur during the initial authorization request phase. You can learn more about troubleshooting common OAuth app errors here:

• Troubleshooting authorization request errors
• Troubleshooting OAuth app access token request errors

GitHub Apps are preferred to OAuth apps because they use fine-grained permissions, give more control over which repositories the app can access, and use short-lived tokens. These properties can harden the security of your app by limiting the damage that could be done if your app's credentials were leaked. They can also act independently of a user so the app will continue to work even if the person who installed the app on an organization leaves the organization. Check out these resources for more information:

• Differences between GitHub Apps and OAuth apps
• Migrating OAuth apps to GitHub Apps

Using GitHub Apps

• Using GitHub Apps

  • About creating GitHub Apps
  • Authorizing GitHub Apps
  • About authentication with a GitHub App
  • Authenticating as a GitHub App installation

• REST API resources for GitHub Apps

  • Permissions required for GitHub Apps to use each REST API endpoint that works with GitHub Apps
  • Endpoints available for GitHub App installation access tokens

💼 GitHub Enterprise Server (GES) Resources

• How to Solve: x509: certificate signed by unknown authority on GitHub Enterprise Server
• GitHub Enterprise Server: Geo-replication overview and implementation
• Making your GitHub App available for GitHub Enterprise Server

📖 Open Source Resources

New to open source? Here are some resources to help you get started:

• Want to start contributing to open source projects? Here’s how to find projects that need help so you can start making impactful contributions today
  • Programming Help Category: For programming questions beyond APIs, Webhooks, and Rate Limits - join the conversation on all things software development in this category.
  • Programming Resources: Check out this post in Programming Help for getting started resources and language-specific hubs.
• Did you know that GitHub’s Docs are open source? 📖Interested in contributing to GitHub’s Docs? Here are a handful of article updates that you can tackle:
  • GraphQL errors, and especially rate limit errors, are not documented
  • Transferring ownership article(s) should contain pointers to how/where transfer request can be approved
• Are you or do you know a college student interested in open source? All In for Students is an online program for college students from underrepresented backgrounds that provides open source education, training, and internship opportunities. They’re doing really cool things, check it out!
• Public APIs: Ever needed to find a free API for your next project, website, or app? Check out the Public APIs Repository

[ChakitBhandari]

I have been trying to go through the GitHub API docs and there is no information mentioned about the response parameters. The doc mentions information about the request parameters but not about the response parameters. I have been trying to use the GitHUB API for a project and I need information about the response parameters as to what each one of them corresponds to? @ghostinhershell Could you please let me know where can I find information about response parameters of each API.

[Yang-ST]

why I can't use "path" in rest api？I remember it can be used before.