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

# Push Custom Event

> Creates a custom event record associated with a user for tracking, and triggering downstream processes. Events are stored with optional categorization and custom data payload.



## OpenAPI

````yaml /openapi.yaml post /event
openapi: 3.0.0
info:
  title: claimr API
  version: 1.0.0
  description: >-
    Advanced features of claimr for business partners. This API provides a
    seamless integration with claimr services
  termsOfService: https://claimr.io/terms-of-service/
  contact:
    name: claimr support team
    email: support@claimr.io
servers:
  - url: https://prod.claimr.io/api/v1
    description: Production server
  - url: https://prod.claimr.io/api/v1
    description: Development server
security: []
tags: []
paths:
  /event:
    post:
      tags:
        - Events
      summary: Push Custom Event
      description: >-
        Creates a custom event record associated with a user for tracking, and
        triggering downstream processes. Events are stored with optional
        categorization and custom data payload.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - account
                - platform
                - pid
                - name
              properties:
                account:
                  type: string
                  description: User account identifier
                  example: user123
                platform:
                  type: string
                  description: Platform identifier where the user account exists
                  example: steam
                pid:
                  type: string
                  description: Campaign ID associated with this event
                  example: campaign_abc123
                name:
                  type: string
                  description: Event name identifier
                  example: level_completed
                id:
                  type: string
                  description: Optional unique event identifier
                  example: evt_xyz789
                category:
                  type: string
                  description: Optional event category for grouping/filtering
                  example: gameplay
                data:
                  type: object
                  description: Optional custom data payload associated with the event
                  additionalProperties: true
                  example:
                    level: 5
                    score: 1250
                    completion_time: 180
                ts:
                  type: number
                  description: >-
                    Optional timestamp (Unix timestamp). If not provided,
                    current time will be used
                  example: 1672531200
      responses:
        '200':
          description: Event created successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  error:
                    type: object
                    properties:
                      code:
                        type: integer
                        format: int32
                        default: 400
                      message:
                        type: string
                        default: bad request
              examples:
                missing_fields:
                  summary: Missing required fields
                  value:
                    error: >-
                      Missing required parameters: pid, account, platform, or
                      name
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/access_denied'
        '500':
          $ref: '#/components/responses/internal_error'
      security:
        - bearer: []
components:
  responses:
    unauthorized:
      description: Unauthorized request
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
              error:
                type: object
                properties:
                  code:
                    type: integer
                    format: int32
                    default: 401
                  message:
                    type: string
                    default: unauthorized
    access_denied:
      description: Access denied
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
              error:
                type: object
                properties:
                  code:
                    type: integer
                    format: int32
                    default: 403
                  message:
                    type: string
                    default: access denied
    internal_error:
      description: Internal server error
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
              error:
                type: object
                properties:
                  code:
                    type: integer
                    format: int32
                    default: 500
                  message:
                    type: string
                    default: internal error
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT

````