---
title: "Webhook Configuration"
url: "https://kiwi.arashsheyda.me/apis/git-hub-v3-rest-api-1/versions/4cb06d26-20a0-409c-8492-8406889b7eb4/schemas/webhook-config"
---

> Full API specification: https://kiwi.arashsheyda.me/apis/git-hub-v3-rest-api-1/versions/4cb06d26-20a0-409c-8492-8406889b7eb4.md

# Webhook Configuration

Configuration object of the webhook

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: GitHub v3 REST API
  version: 1.1.4
servers:
  - url: "{protocol}://{hostname}/api/v3"
    variables:
      hostname:
        description: Self-hosted Enterprise Server or Enterprise Cloud hostname
        default: HOSTNAME
      protocol:
        description: Self-hosted Enterprise Server or Enterprise Cloud protocol
        default: http
components:
  schemas:
    webhook-config-url:
      type: string
      description: The URL to which the payloads will be delivered.
      example: https://example.com/webhook
      format: uri
    webhook-config-content-type:
      type: string
      description: The media type used to serialize the payloads. Supported values
        include `json` and `form`. The default is `form`.
      example: '"json"'
    webhook-config-secret:
      type: string
      description: 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/enterprise-server@3.0/webhooks/event-payloads/#delivery-headers).
      example: '"********"'
    webhook-config-insecure-ssl:
      oneOf:
        - type: string
          description: 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.**
          example: '"0"'
        - type: number
    webhook-config:
      title: Webhook Configuration
      description: Configuration object of the webhook
      type: object
      properties:
        url:
          $ref: "#/components/schemas/webhook-config-url"
        content_type:
          $ref: "#/components/schemas/webhook-config-content-type"
        secret:
          $ref: "#/components/schemas/webhook-config-secret"
        insecure_ssl:
          $ref: "#/components/schemas/webhook-config-insecure-ssl"
```