GitHub: Get a webhook delivery for an organization webhook

GitHub orgs.orgsGetWebhookDelivery: arguments, response, policy and SDK examples.

Operation github.orgs_get_webhook_delivery

Provider route: GET /orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}. 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"]["orgsGetWebhookDelivery"]>[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.orgsGetWebhookDelivery(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_get_webhook_delivery(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
`path.hook_id`	integer	Required within parent
`path.delivery_id`	integer	Required within parent

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 delivery for a repository webhook — response body

Referenced models: Get a delivery for a repository webhook — response body

Schemas

Get a delivery for a repository webhook — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Delivery made by a webhook.
`action`	JSON	Required within parent
`action (anyOf 1)`	string	Alternative	The type of activity for the event that triggered the delivery.
`action (anyOf 2)`	null	Alternative
`delivered_at`	string	Required within parent	Time when the delivery was delivered. Format: date-time
`duration`	JSON	Required within parent
`duration (anyOf 1)`	number	Alternative	Time spent delivering.
`duration (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`event`	string	Required within parent	The event that triggered the delivery.
`guid`	string	Required within parent	Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event).
`id`	JSON	Required within parent
`id (anyOf 1)`	integer	Alternative	Unique identifier of the delivery.
`id (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`installation_id`	JSON	Required within parent
`installation_id (anyOf 1)`	JSON	Alternative
`installation_id (anyOf 1) (anyOf 1)`	integer	Alternative	The id of the GitHub App installation associated with this event.
`installation_id (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`installation_id (anyOf 2)`	null	Alternative
`redelivery`	boolean	Required within parent	Whether the delivery is a redelivery.
`repository_id`	JSON	Required within parent
`repository_id (anyOf 1)`	JSON	Alternative
`repository_id (anyOf 1) (anyOf 1)`	integer	Alternative	The id of the repository associated with this event.
`repository_id (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`repository_id (anyOf 2)`	null	Alternative
`request`	object	Required within parent
`request.headers`	JSON	Required within parent
`request.headers (anyOf 1)`	object	Alternative	The request headers sent with the webhook delivery. Additional keys: allowed
`request.headers (anyOf 2)`	null	Alternative
`request.payload`	JSON	Required within parent
`request.payload (anyOf 1)`	object	Alternative	The webhook payload. Additional keys: allowed
`request.payload (anyOf 2)`	null	Alternative
`response`	object	Required within parent
`response.headers`	JSON	Required within parent
`response.headers (anyOf 1)`	object	Alternative	The response headers received when the delivery was made. Additional keys: allowed
`response.headers (anyOf 2)`	null	Alternative
`response.payload`	JSON	Required within parent
`response.payload (anyOf 1)`	string	Alternative	The response payload received. Additional keys: allowed
`response.payload (anyOf 2)`	null	Alternative
`status`	string	Required within parent	Description of the status of the attempted delivery
`status_code`	JSON	Required within parent
`status_code (anyOf 1)`	integer	Alternative	Status code received when delivery was made.
`status_code (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`throttled_at`	JSON	Optional
`throttled_at (anyOf 1)`	string	Alternative	Time when the webhook delivery was throttled. Format: date-time
`throttled_at (anyOf 2)`	null	Alternative
`url`	string	Optional	The URL target of the delivery.

Policy, approvals and errors

SDK function policy ID: github.orgs_get_webhook_delivery. Catalog operation: orgs/get-webhook-delivery. 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

Report an issue with this page