GitHub: Create a repository webhook

← Repos operations · Get started

Operation github.repos_create_webhook

Provider route: POST /repos/{owner}/{repo}/hooks. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/github with npm, or alter-sdk-github with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { GitHubIntegration } from "@alter-ai/github";

async function execute(input: Parameters<GitHubIntegration["repos"]["reposCreateWebhook"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new GitHubIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.repos.reposCreateWebhook(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_github import GitHubIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = GitHubIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.repos.repos_create_webhook(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.owner	string	Required within parent
path.repo	string	Required within parent
body	JSON	Optional
body (anyOf 1)	object	Alternative	Additional keys: not allowed
body (anyOf 1).active	boolean	Optional	Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. Default: true
body (anyOf 1).config	object	Optional	Key/value pairs to provide settings for this webhook.
body (anyOf 1).config.content_type	string	Optional	The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.
body (anyOf 1).config.insecure_ssl	Model	Optional	Expand Update a webhook configuration for a repository — request body — body insecure ssl
body (anyOf 1).config.secret	string	Optional	If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).
body (anyOf 1).config.url	string	Optional	The URL to which the payloads will be delivered. Format: uri
body (anyOf 1).events	array	Optional	Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. Default: [“push”]
body (anyOf 1).events[]	string	Each item
body (anyOf 1).name	string	Optional	Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `web`.
body (anyOf 2)	null	Alternative

Referenced models: Update a webhook configuration for a repository — request body — body insecure ssl

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Get a repository webhook — response body

Referenced models: Get a repository webhook — response body

Schemas

Get a repository webhook — response body

Field	Type	Presence	Description and constraints
$	object	Root	Webhooks for repositories.
active	boolean	Required within parent	Determines whether the hook is actually triggered on pushes.
config	Model	Required within parent	Expand Get a webhook configuration for a repository — response body
created_at	string	Required within parent	Format: date-time
deliveries_url	string	Optional	Format: uri
events	array	Required within parent	Determines what events the hook is triggered for. Default: ['push'].
events[]	string	Each item
id	JSON	Required within parent
id (anyOf 1)	integer	Alternative	Unique identifier of the webhook.
id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
last_response	Model	Required within parent	Expand Get a repository webhook — response body — last response
name	string	Required within parent	The name of a valid service, use 'web' for a webhook.
ping_url	string	Required within parent	Format: uri
test_url	string	Required within parent	Format: uri
type	string	Required within parent
updated_at	string	Required within parent	Format: date-time
url	string	Required within parent	Format: uri

Referenced models: Get a repository webhook — response body — last response, Get a webhook configuration for a repository — response body

Update a webhook configuration for a repository — request body — body insecure ssl

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (oneOf 1)	string	Alternative	Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**
$ (oneOf 2)	number	Alternative

Get a repository webhook — response body — last response

Field	Type	Presence	Description and constraints
$	object	Root
code	JSON	Required within parent
code (anyOf 1)	JSON	Alternative
code (anyOf 1) (anyOf 1)	integer	Alternative
code (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
code (anyOf 2)	null	Alternative
message	JSON	Required within parent
message (anyOf 1)	string	Alternative
message (anyOf 2)	null	Alternative
status	JSON	Required within parent
status (anyOf 1)	string	Alternative
status (anyOf 2)	null	Alternative

Get a webhook configuration for a repository — response body

Field	Type	Presence	Description and constraints
$	object	Root	Configuration object of the webhook
content_type	string	Optional	The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.
insecure_ssl	Model	Optional	Expand Get a webhook configuration for a repository — response body — insecure ssl
secret	string	Optional	If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).
url	string	Optional	The URL to which the payloads will be delivered. Format: uri

Referenced models: Get a webhook configuration for a repository — response body — insecure ssl

Get a webhook configuration for a repository — response body — insecure ssl

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	string	Alternative	Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**
$ (anyOf 2)	JSON	Alternative
$ (anyOf 2) (anyOf 1)	number	Alternative
$ (anyOf 2) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Policy, approvals and errors

SDK function policy ID: github.repos_create_webhook. Catalog operation: repos/create-webhook. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"X-GitHub-Api-Version": "2026-03-10", "User-Agent": "Alter", "Accept": "application/vnd.github+json"}

Official provider source