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

# Register an alert webhook



## OpenAPI

````yaml /api-reference/openapi.json post /webhooks
openapi: 3.0.0
info:
  title: asobeast API
  description: Self hosted ASO toolkit API
  version: 0.4.0
  contact: {}
servers:
  - url: http://localhost:3000/api/backend
    description: Web origin proxy
  - url: http://localhost:4000
    description: Direct API
security:
  - personalApiToken: []
tags: []
paths:
  /webhooks:
    post:
      tags:
        - webhooks
      summary: Register an alert webhook
      operationId: WebhooksController_create
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateWebhookDto'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                type: object
components:
  schemas:
    CreateWebhookDto:
      type: object
      properties:
        url:
          type: string
          format: uri
        events:
          type: array
          minItems: 1
          items:
            type: string
            enum:
              - metadata.changed
              - rank.dropped
              - rank.improved
              - review.negative
              - digest.weekly
              - serp.entrant
              - action.opened
        secret:
          type: string
          minLength: 8
      required:
        - url
        - events
  securitySchemes:
    personalApiToken:
      scheme: bearer
      bearerFormat: asob
      type: http

````