Interface GitHubWebhook

Represents a GitHub repository webhook.

See

https://docs.github.com/en/rest/webhooks/repos#get-a-repository-webhook

interface GitHubWebhook {
    active: boolean;
    config: {
        content_type?: string;
        insecure_ssl?: string;
        secret?: string;
        url: string;
    };
    created_at: string;
    deliveries_url: string;
    events: string[];
    id: number;
    name: string;
    ping_url: string;
    updated_at: string;
}

Properties

active config created_at deliveries_url events id name ping_url updated_at

Properties

active

active: boolean

Whether the webhook is active

config

config: {
    content_type?: string;
    insecure_ssl?: string;
    secret?: string;
    url: string;
}

Webhook configuration

Type declaration

  • Optionalcontent_type?: string

    Payload format ('json' or 'form')

  • Optionalinsecure_ssl?: string

    Whether SSL verification is disabled ('0' = disabled, '1' = enabled)

  • Optionalsecret?: string

    HMAC secret for payload verification

  • url: string

    Payload delivery URL

created_at

created_at: string

ISO 8601 timestamp of creation

deliveries_url

deliveries_url: string

URL to list webhook deliveries

events

events: string[]

List of events that trigger this webhook

id

id: number

Unique numeric webhook ID

name

name: string

Webhook name — always 'web' for repository webhooks

ping_url

ping_url: string

URL to ping this webhook

updated_at

updated_at: string

ISO 8601 timestamp of last update

Settings

Member Visibility

On This Page

Properties