Type alias Manifest

Type declaration

• Optional callback_urls?: string[]

  A full URL to redirect to after someone authorizes an installation. You can provide up to 10 callback URLs.

• Optional default_events?: WebhookEvent[]

  The list of events the GitHub App subscribes to.

• Optional default_permissions?: "read-all" | "write-all" | Record<ManifestPermissionScope, ManifestPermissionValue>

  The set of permissions needed by the GitHub App. The format of the object uses the permission name for the key (for example, issues) and the access type for the value (for example, write).

• Optional description?: string

  A description of the GitHub App.

• Optional hook_attributes?: {
      active?: boolean;
      url: string;
  }

  The configuration of the GitHub App's webhook.

  • Optional active?: boolean

  • url: string

• Optional name?: string

  The name of the GitHub App.

• Optional public?: boolean

  Set to true when your GitHub App is available to the public or false when it is only accessible to the owner of the app.

• Optional redirect_url?: string

  The full URL to redirect to after a user initiates the registration of a GitHub App from a manifest.

• Optional request_oauth_on_install?: boolean

  Set to true to request the user to authorize the GitHub App, after the GitHub App is installed.

• Optional setup_on_update?: boolean

  Set to true to redirect users to the setup_url after they update your GitHub App installation.

• Optional setup_url?: string

  A full URL to redirect users to after they install your GitHub App if additional setup is required.

• url: string

  Required. The homepage of your GitHub App.