# Add webhook

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /v1/users/webhook:
    post:
      summary: Add webhook
      deprecated: false
      description: >-
        ### 📡 Webhook API (File Process Notification)


        Clients can register a **webhook endpoint** to receive automatic
        notifications when a file has been processed by Snapbyte.


        Once processing is complete, Snapbyte will send a `POST` request to your
        webhook URL with the following JSON payload:


        ```json

        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "status": "done",
        }


        or


        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "status": "error",
        }

        ```
      tags:
        - Snapbyte APIs/Basic
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                webhook:
                  type: string
                  description: Webhook Url
              x-apidog-orders:
                - webhook
              required:
                - webhook
            examples: {}
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties: {}
              example:
                success: true
                message: Updated
                data: {}
          headers: {}
          x-apidog-name: Success
      security: []
      x-apidog-folder: Snapbyte APIs/Basic
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/991601/apis/api-19077568-run
components:
  schemas: {}
  securitySchemes: {}
servers:
  - url: https://api.snapbyte.io
    description: Prod Env
security: []

```