vivenu Notifications API

The notifications API from vivenu — 3 operation(s) for notifications.

Operations 5

GET /api/notifications Get all notifications #
GET /api/notifications/preferences Get notification settings for the authenticated user #
PATCH /api/notifications/preferences Update notification settings for the authenticated user #
GET /api/action-notification/{type}/{id} Get action notification subscription #
POST /api/action-notification/{type}/{id} Update action notification subscription #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/vivenu-notifications-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

vivenu-notifications-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: vivenu Notifications API
  description: vivenu API Documentation
  version: 1.0.0
  contact:
    name: vivenu GmbH
    url: https://vivenu.com
servers:
- url: https://vivenu.com
  description: Production API
- url: https://vivenu.dev
  description: Staging API
tags:
- name: Notifications
paths:
  /api/notifications:
    get:
      security:
      - jwt: []
      parameters:
      - name: top
        required: false
        schema:
          type: number
          format: float
          default: 100
          metas: {}
        in: query
        style: form
        explode: true
      - name: skip
        required: false
        schema:
          type: number
          format: float
          metas: {}
        in: query
        style: form
        explode: true
      - name: methods
        required: false
        schema:
          type: string
          description: The notification methods to filter for
          metas: {}
        in: query
        style: form
        explode: true
      responses:
        '200':
          description: OK
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
      tags:
      - Notifications
      operationId: get_all_notifications
      summary: Get all notifications
      x-summary-source: derived
  /api/notifications/preferences:
    get:
      security:
      - jwt: []
      parameters:
      - name: locale
        required: false
        schema:
          type: string
          metas: {}
        in: query
        style: form
        explode: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GET_Notifications_GetNotificationSettingsForTheAuthenticatedUser_200_response'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
      tags:
      - Notifications
      operationId: get_notification_settings_for_the_authenticated_user
      summary: Get notification settings for the authenticated user
      x-summary-source: derived
    patch:
      security:
      - jwt: []
      parameters:
      - name: locale
        required: false
        schema:
          type: string
          metas: {}
        in: query
        style: form
        explode: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PATCH_Notifications_UpdateNotificationSettingsForTheAuthenticatedUser_200_response'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PATCH_Notifications_UpdateNotificationSettingsForTheAuthenticatedUser'
      tags:
      - Notifications
      operationId: update_notification_settings_for_the_authenticated_user
      summary: Update notification settings for the authenticated user
      x-summary-source: derived
  /api/action-notification/{type}/{id}:
    get:
      security:
      - jwt: []
      parameters:
      - name: type
        required: true
        schema:
          type: string
          enum:
          - ticket.checkin
          metas: {}
        in: path
      - name: id
        required: false
        schema:
          type: string
          metas: {}
        in: path
      responses:
        '200':
          description: OK
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
      tags:
      - Notifications
      description: Get Action Notification Subscription
      operationId: get_action_notification_subscription
      summary: Get action notification subscription
      x-summary-source: derived
    post:
      security:
      - jwt: []
      parameters:
      - name: type
        required: true
        schema:
          type: string
          enum:
          - ticket.checkin
          metas: {}
        in: path
      - name: id
        required: false
        schema:
          type: string
          metas: {}
        in: path
      responses:
        '200':
          description: OK
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POST_Notifications_UpdateActionNotificationSubscription'
      tags:
      - Notifications
      description: Update Action Notification Subscription
      operationId: update_action_notification_subscription
      summary: Update action notification subscription
      x-summary-source: derived
components:
  schemas:
    PATCH_Notifications_UpdateNotificationSettingsForTheAuthenticatedUser:
      type: object
      properties:
        preferences:
          type: array
          items:
            type: object
            properties:
              trigger:
                type: string
                enum:
                - job.completed
                - transaction.completed
                - purchaseIntent.created
                - fulfillmentJob.created
                - customer.created
                - support.supportAssignedToSeller
                - ticket.checked-in
                - security.new-device
                - security.password-reset
                - security.apiKey.created
                - payments.chargeback.created
                - payments.failed
                - payments.paymentPlans.installment.failed
                - payments.paymentPlans.completed
                - vivenuPayments.account.restrictedSoon
                - vivenuPayments.account.restricted
                - subscriptions.payments.schedules.maxRetriesReached
                - pos.opened
                - pos.closed
                - accounting.payout.initiated
                - invoice.fiscalization.failed
              methods:
                type: array
                items:
                  type: string
                  enum:
                  - push
                  - email
                  - dashboard
            required:
            - trigger
            - methods
          minItems: 1
      required:
      - preferences
    GET_Notifications_GetNotificationSettingsForTheAuthenticatedUser_200_response:
      type: object
      properties:
        triggers:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
                enum:
                - job.completed
                - transaction.completed
                - purchaseIntent.created
                - fulfillmentJob.created
                - customer.created
                - support.supportAssignedToSeller
                - ticket.checked-in
                - security.new-device
                - security.password-reset
                - security.apiKey.created
                - payments.chargeback.created
                - payments.failed
                - payments.paymentPlans.installment.failed
                - payments.paymentPlans.completed
                - vivenuPayments.account.restrictedSoon
                - vivenuPayments.account.restricted
                - subscriptions.payments.schedules.maxRetriesReached
                - pos.opened
                - pos.closed
                - accounting.payout.initiated
                - invoice.fiscalization.failed
                description: The notification trigger type
              methods:
                type: array
                items:
                  type: string
                  enum:
                  - push
                  - email
                  - dashboard
                description: Selected notification methods
              defaultMethods:
                type: array
                items:
                  type: string
                  enum:
                  - push
                  - email
                  - dashboard
                description: Default notification methods
              requiredMethods:
                type: array
                items:
                  type: string
                  enum:
                  - push
                  - email
                  - dashboard
                description: Required notification methods that cannot be disabled
              defaultLevel:
                type: string
                enum:
                - critical
                - high
                - medium
                - low
                - none
                description: Default notification level
            required:
            - type
            - methods
            - defaultMethods
            - defaultLevel
          description: All notification triggers with their settings
      required:
      - triggers
    PATCH_Notifications_UpdateNotificationSettingsForTheAuthenticatedUser_200_response:
      type: object
      properties:
        triggers:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
                enum:
                - job.completed
                - transaction.completed
                - purchaseIntent.created
                - fulfillmentJob.created
                - customer.created
                - support.supportAssignedToSeller
                - ticket.checked-in
                - security.new-device
                - security.password-reset
                - security.apiKey.created
                - payments.chargeback.created
                - payments.failed
                - payments.paymentPlans.installment.failed
                - payments.paymentPlans.completed
                - vivenuPayments.account.restrictedSoon
                - vivenuPayments.account.restricted
                - subscriptions.payments.schedules.maxRetriesReached
                - pos.opened
                - pos.closed
                - accounting.payout.initiated
                - invoice.fiscalization.failed
                description: The notification trigger type
              methods:
                type: array
                items:
                  type: string
                  enum:
                  - push
                  - email
                  - dashboard
                description: Selected notification methods
              defaultMethods:
                type: array
                items:
                  type: string
                  enum:
                  - push
                  - email
                  - dashboard
                description: Default notification methods
              requiredMethods:
                type: array
                items:
                  type: string
                  enum:
                  - push
                  - email
                  - dashboard
                description: Required notification methods that cannot be disabled
              defaultLevel:
                type: string
                enum:
                - critical
                - high
                - medium
                - low
                - none
                description: Default notification level
            required:
            - type
            - methods
            - defaultMethods
            - defaultLevel
          description: All notification triggers with their settings
      required:
      - triggers
    POST_Notifications_UpdateActionNotificationSubscription:
      type: object
      properties:
        subscribed:
          type: boolean
          default: true
  securitySchemes:
    jwt:
      type: http
      scheme: bearer
      bearerFormat: JWT
    apikey:
      type: apiKey
      scheme: bearer
      in: header
      name: Authorization
    customer-jwt:
      type: http
      scheme: bearer
      bearerFormat: JWT
    orgApiKey:
      type: apiKey
      scheme: bearer
      in: header
      name: Authorization