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

# Report a delivery event

> Idempotently records a received, displayed, opened, or dismissed event.



## OpenAPI

````yaml /openapi.yaml post /api/v1/events
openapi: 3.0.3
info:
  title: Pushctl API
  version: 1.0.0
  description: >-
    Application-scoped APIs for registering installations, sending push
    notifications, and tracking delivery events.
  license:
    name: Proprietary
servers:
  - url: https://pushctl.com
security:
  - bearerAuth: []
tags:
  - name: Installations
    description: Register and maintain mobile app installations.
  - name: Notifications
    description: Create notifications and inspect their delivery lifecycle.
  - name: Delivery events
    description: Report lifecycle events emitted by a client installation.
paths:
  /api/v1/events:
    post:
      tags:
        - Delivery events
      summary: Report a delivery event
      description: Idempotently records a received, displayed, opened, or dismissed event.
      operationId: reportADeliveryEvent
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeliveryEventRequest'
      responses:
        '200':
          description: The event already existed and was returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeliveryEventResponse'
        '201':
          description: Event created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeliveryEventResponse'
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/ValidationError'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    DeliveryEventRequest:
      type: object
      required:
        - event_id
        - delivery_id
        - installation_id
        - type
        - occurred_at
      properties:
        event_id:
          type: string
          format: uuid
        delivery_id:
          type: string
          description: Delivery ULID.
        installation_id:
          type: string
          maxLength: 255
        type:
          type: string
          enum:
            - received
            - displayed
            - opened
            - dismissed
        occurred_at:
          type: string
          format: date-time
        metadata:
          type: object
          nullable: true
          additionalProperties: true
    DeliveryEventResponse:
      type: object
      required:
        - data
      properties:
        data:
          $ref: '#/components/schemas/DeliveryEvent'
    DeliveryEvent:
      type: object
      properties:
        event_id:
          type: string
          format: uuid
        delivery_id:
          type: string
        installation_id:
          type: string
        type:
          type: string
          enum:
            - received
            - displayed
            - opened
            - dismissed
        occurred_at:
          type: string
          format: date-time
        received_at:
          type: string
          format: date-time
    Error:
      type: object
      required:
        - message
      properties:
        message:
          type: string
  responses:
    Unauthenticated:
      description: Token is missing, invalid, or revoked.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            message: Unauthenticated.
    Forbidden:
      description: The token lacks the required ability.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            message: This action is unauthorized.
    NotFound:
      description: Resource was not found for this application.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            message: Not Found
    ValidationError:
      description: Request validation failed.
      content:
        application/json:
          schema:
            allOf:
              - $ref: '#/components/schemas/Error'
              - type: object
                properties:
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
    RateLimited:
      description: Per-application rate limit exceeded.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: application token
      description: >-
        Use an application-scoped token with the ability required by the
        endpoint.

````