> ## 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 email alert



## OpenAPI

````yaml /api-reference/openapi.json post /email-alerts
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:
  /email-alerts:
    post:
      tags:
        - email-alerts
      summary: Register an email alert
      operationId: EmailAlertsController_create
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateEmailAlertDto'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                type: object
components:
  schemas:
    CreateEmailAlertDto:
      type: object
      properties:
        email:
          type: string
          format: email
        events:
          type: array
          minItems: 1
          items:
            type: string
            enum:
              - metadata.changed
              - rank.dropped
              - rank.improved
              - review.negative
              - digest.weekly
              - serp.entrant
              - action.opened
      required:
        - email
        - events
  securitySchemes:
    personalApiToken:
      scheme: bearer
      bearerFormat: asob
      type: http

````