GitHub: Create an organization webhook

← Orgs operations · Get started

Operation github.orgs_create_webhook

Provider route: POST /orgs/{org}/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["orgs"]["orgsCreateWebhook"]>[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.orgs.orgsCreateWebhook(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.orgs.orgs_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.org	string	Required within parent
body	object	Required within parent
body.active	boolean	Optional	Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. Default: true
body.config	object	Required within parent	Key/value pairs to provide settings for this webhook.
body.config.content_type	string	Optional	The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.
body.config.insecure_ssl	Model	Optional	Expand Update a webhook configuration for a repository — request body — body insecure ssl
body.config.password	string	Optional
body.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.config.url	string	Required within parent	The URL to which the payloads will be delivered. Format: uri
body.config.username	string	Optional
body.events	array	Optional	Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. Set to `[”*”]` to receive all possible events. Default: [“push”]
body.events[]	string	Each item
body.name	string	Required within parent	Must be passed as “web”.

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 an organization webhook — response body

Referenced models: Get an organization webhook — response body

Schemas

Get an organization webhook — response body

Field	Type	Presence	Description and constraints
$	object	Root	Org Hook
active	boolean	Required within parent
config	object	Required within parent
config.content_type	string	Optional
config.insecure_ssl	string	Optional
config.secret	string	Optional
config.url	string	Optional
created_at	string	Required within parent	Format: date-time
deliveries_url	string	Optional	Format: uri
events	array	Required within parent
events[]	string	Each item
id	JSON	Required within parent
id (anyOf 1)	integer	Alternative
id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
name	string	Required within parent
ping_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

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

Policy, approvals and errors

SDK function policy ID: github.orgs_create_webhook. Catalog operation: orgs/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