Whiplash Merchandising notification_events API

openapi: 3.1.0
info:
  version: '2.0'
  title: Rydership bundle_items notification_events API
  description: 'The Rydership V2 API is open by invite only. Fill out request form <a href="https://help.whiplash.com/hc/en-us/requests/new?ticket_form_id=360001303092"> here</a>.

    <br>

    <a href="api.v2.html">V2 documentation</a>

    <br>

    <a href="api.v2-1.html">V2.1 documentation</a>

    '
  contact:
    name: Rydership Development Team
    email: tech@whiplash.com
    url: https://www.getwhiplash.com
  x-logo:
    url: https://wl-s3-assets.s3.amazonaws.com/rydership/RyderShip-horizontal-safe-padding.svg
    backgroundColor: '#FFFFFF'
    altText: RyderShip
servers:
- url: ''
  description: Base Path
tags:
- name: notification_events
  description: System event definitions for notifications.
paths:
  /api/v2/notification_events:
    get:
      operationId: GetApiV2NotificationEvents
      tags:
      - notification_events
      summary: List all notification events
      description: Get a list of notification events
      parameters:
      - name: search
        in: query
        required: false
        schema:
          type: string
          description: 'JSON search string like {"attribute_eq": "Term"}'
      - name: fields
        in: query
        required: false
        schema:
          type: string
          description: Comma-separated list of fields to include in the response
      - name: sort
        in: query
        required: false
        schema:
          type: string
          description: 'A list of sort options (ex: name asc,created_at desc)'
      - name: page
        in: query
        required: false
        schema:
          type: integer
          format: int32
          description: Page of results to fetch
      - name: per_page
        in: query
        required: false
        schema:
          type: integer
          format: int32
          description: Number of results to return per page
      - name: page_total
        in: query
        required: false
        schema:
          type: boolean
          description: Include total count of results
      - name: page_links
        in: query
        required: false
        schema:
          type: boolean
          description: Include prev/next links in response headers
      responses:
        '200':
          description: Get a list of notification events
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ApiV2EntitiesNotificationEvent'
              examples: null
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSharedEntitiesApiError'
        '403':
          description: forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSharedEntitiesApiError'
  /api/v2/notification_events/{id}:
    get:
      operationId: GetApiV2NotificationEventsId
      tags:
      - notification_events
      summary: Retrieve a notification event
      description: Get a notification event
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Get a notification event
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiV2EntitiesNotificationEvent'
              examples: null
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSharedEntitiesApiError'
        '403':
          description: forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSharedEntitiesApiError'
components:
  schemas:
    ApiSharedEntitiesApiError:
      type: object
      title: Shared
      properties:
        message:
          type: string
          description: error message
      additionalProperties: false
    ApiV2EntitiesNotificationEvent:
      type: object
      title: V2
      properties:
        id:
          type: integer
          format: int32
          description: the notification event id
        name:
          type:
          - string
          - 'null'
          description: the name of the event
        humanized_name:
          type: string
          description: a more readable name of the event
        resource_type:
          type:
          - string
          - 'null'
          description: the type of resource this event is attached to
        resource_message:
          type:
          - string
          - 'null'
          description: the verb for this event
        requires_subscription:
          type:
          - boolean
          - 'null'
          description: Whether or not this event requires customer subscription
        description:
          type: string
          description: what the event is, and when it fires
        created_at:
          type: string
          format: date-time
          description: the notification event creation date and time
        updated_at:
          type: string
          format: date-time
          description: the notification event last update date and time
      additionalProperties: false