> ## Documentation Index
> Fetch the complete documentation index at: https://docs.go-fetch.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a webhook

> Registers a URL for job events. The response carries `signing_secret` in full, the only time it is shown: every delivery is signed with it as `sha256=<hex HMAC-SHA256 of the body>` in the `X-Webhook-Signature` header.



## OpenAPI

````yaml /openapi.json post /api/v1/webhooks/
openapi: 3.0.3
info:
  title: Go-Fetch API
  version: v1
servers:
  - url: https://go-fetch.io
security: []
tags:
  - name: Jobs
    description: >-
      A job is one scrape. Create it with a scraper type and its input, follow
      it until it is completed, failed, timed_out or cancelled, then page
      through its results.
  - name: Webhooks
    description: >-
      URLs we POST to when a job finishes, signed with your webhook secret in
      the X-Webhook-Signature header, and the log of every delivery.
  - name: Usage
    description: Billable usage, one record per charge.
  - name: Pricing
    description: List prices per platform and a cost estimate. No API key needed.
  - name: API keys
    description: >-
      Your organization's API keys. Creating, changing and rotating a key needs
      a key with the admin scope.
  - name: Organizations
    description: >-
      The organization your key belongs to: its environments, members, this
      month's usage and the audit log.
paths:
  /api/v1/webhooks/:
    post:
      tags:
        - Webhooks
      summary: Create a webhook
      description: >-
        Registers a URL for job events. The response carries `signing_secret` in
        full, the only time it is shown: every delivery is signed with it as
        `sha256=<hex HMAC-SHA256 of the body>` in the `X-Webhook-Signature`
        header.
      operationId: webhooks_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/WebhookRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/WebhookRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Webhook'
          description: ''
      security:
        - ApiKeyAuth: []
components:
  schemas:
    WebhookRequest:
      type: object
      properties:
        url:
          type: string
          format: uri
          minLength: 1
          maxLength: 200
        events:
          description: Events to listen for
        is_active:
          type: boolean
      required:
        - url
    Webhook:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        organization:
          type: string
          format: uuid
          readOnly: true
        url:
          type: string
          format: uri
          maxLength: 200
        events:
          description: Events to listen for
        is_active:
          type: boolean
        signing_secret:
          type: string
          description: >-
            In full in the create response only; its first 8 characters and
            `...` after.
          readOnly: true
        failed_deliveries:
          type: integer
          readOnly: true
        disabled_reason:
          type: string
          readOnly: true
        last_delivery_at:
          type: string
          format: date-time
          readOnly: true
          nullable: true
        created_at:
          type: string
          format: date-time
          readOnly: true
      required:
        - created_at
        - disabled_reason
        - failed_deliveries
        - id
        - last_delivery_at
        - organization
        - signing_secret
        - url
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.