actionbox-cloud

actionbox-cloud Notifications API

The notifications API from actionbox-cloud — 6 operation(s) for notifications.

GitHub OpenAPI

Operations 8

GET /v1/notifications Notifications Endpoint #
GET /v1/notifications/summary Notification Summary Endpoint #
POST /v1/notifications/read-all Read All Notifications Endpoint #
POST /v1/notifications/{notification_id}/read Read Notification Endpoint #
GET /v1/notification-preferences Notification Preferences Endpoint #
PATCH /v1/notification-preferences Update Notification Preferences Endpoint #
GET /v1/workspaces/notification-policy Workspace Notification Policy Endpoint #
PATCH /v1/workspaces/notification-policy Update Workspace Notification Policy Endpoint #

Documentation

📖
Documentation
https://actionbox.cloud/docs
📖
APIReference
https://actionbox.cloud/docs/api-reference
📖
GettingStarted
https://actionbox.cloud/docs/quickstart

Specifications

⚙
OpenAPI
https://artifacts.apis.io/actionbox-cloud/openapi/actionbox-cloud-notifications-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/actionbox-cloud/json-schema/actionbox-cloud-action-create-schema.json
📊
JSONSchema
https://artifacts.apis.io/actionbox-cloud/json-schema/actionbox-cloud-action-patch-schema.json
📊
JSONSchema
https://artifacts.apis.io/actionbox-cloud/json-schema/actionbox-cloud-resolve-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/actionbox-cloud/json-schema/actionbox-cloud-decision-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/actionbox-cloud/json-schema/actionbox-cloud-user-watch-create-schema.json
📊
JSONSchema
https://artifacts.apis.io/actionbox-cloud/json-schema/actionbox-cloud-notification-preference-update-schema.json

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/actionbox-cloud:actionbox-cloud-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.

GitHub Google LinkedIn

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

OpenAPI Specification

actionbox-cloud-notifications-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Actionbox Notifications API
  description: Durable human decisions for software that cannot wait at the terminal.
  version: 0.2.1
servers:
- url: https://api.actionbox.cloud
tags:
- name: Notifications
paths:
  /v1/notifications:
    get:
      tags:
      - Notifications
      summary: Notifications Endpoint
      operationId: notifications_endpoint_v1_notifications_get
      parameters:
      - name: unread_only
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Unread Only
      - name: x-user-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-User-Id
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: X-Actionbox-Client
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Actionbox-Client
      - name: actionbox_session
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Actionbox Session
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Notifications Endpoint V1 Notifications Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - UserBearer: []
      - SessionCookie: []
  /v1/notifications/summary:
    get:
      tags:
      - Notifications
      summary: Notification Summary Endpoint
      operationId: notification_summary_endpoint_v1_notifications_summary_get
      parameters:
      - name: x-user-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-User-Id
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: X-Actionbox-Client
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Actionbox-Client
      - name: actionbox_session
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Actionbox Session
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Notification Summary Endpoint V1 Notifications Summary Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - UserBearer: []
      - SessionCookie: []
  /v1/notifications/read-all:
    post:
      tags:
      - Notifications
      summary: Read All Notifications Endpoint
      operationId: read_all_notifications_endpoint_v1_notifications_read_all_post
      parameters:
      - name: x-user-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-User-Id
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: X-Actionbox-Client
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Actionbox-Client
      - name: actionbox_session
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Actionbox Session
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Read All Notifications Endpoint V1 Notifications Read All Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - UserBearer: []
      - SessionCookie: []
  /v1/notifications/{notification_id}/read:
    post:
      tags:
      - Notifications
      summary: Read Notification Endpoint
      operationId: read_notification_endpoint_v1_notifications__notification_id__read_post
      parameters:
      - name: notification_id
        in: path
        required: true
        schema:
          type: string
          title: Notification Id
      - name: x-user-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-User-Id
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: X-Actionbox-Client
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Actionbox-Client
      - name: actionbox_session
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Actionbox Session
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Read Notification Endpoint V1 Notifications  Notification Id  Read Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - UserBearer: []
      - SessionCookie: []
  /v1/notification-preferences:
    get:
      tags:
      - Notifications
      summary: Notification Preferences Endpoint
      operationId: notification_preferences_endpoint_v1_notification_preferences_get
      parameters:
      - name: x-user-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-User-Id
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: X-Actionbox-Client
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Actionbox-Client
      - name: actionbox_session
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Actionbox Session
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Notification Preferences Endpoint V1 Notification Preferences Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - UserBearer: []
      - SessionCookie: []
    patch:
      tags:
      - Notifications
      summary: Update Notification Preferences Endpoint
      operationId: update_notification_preferences_endpoint_v1_notification_preferences_patch
      parameters:
      - name: x-user-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-User-Id
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: X-Actionbox-Client
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Actionbox-Client
      - name: actionbox_session
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Actionbox Session
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationPreferenceUpdate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Update Notification Preferences Endpoint V1 Notification Preferences Patch
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - UserBearer: []
      - SessionCookie: []
  /v1/workspaces/notification-policy:
    get:
      tags:
      - Notifications
      summary: Workspace Notification Policy Endpoint
      operationId: workspace_notification_policy_endpoint_v1_workspaces_notification_policy_get
      parameters:
      - name: x-user-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-User-Id
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: X-Actionbox-Client
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Actionbox-Client
      - name: actionbox_session
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Actionbox Session
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Workspace Notification Policy Endpoint V1 Workspaces Notification Policy Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - UserBearer: []
      - SessionCookie: []
    patch:
      tags:
      - Notifications
      summary: Update Workspace Notification Policy Endpoint
      operationId: update_workspace_notification_policy_endpoint_v1_workspaces_notification_policy_patch
      parameters:
      - name: x-user-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-User-Id
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: X-Actionbox-Client
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Actionbox-Client
      - name: actionbox_session
        in: cookie
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Actionbox Session
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkspaceNotificationPolicyUpdate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Update Workspace Notification Policy Endpoint V1 Workspaces Notification Policy Patch
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - UserBearer: []
      - SessionCookie: []
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    NotificationPreferenceUpdate:
      properties:
        push_enabled:
          type: boolean
          title: Push Enabled
        new_action_enabled:
          type: boolean
          title: New Action Enabled
          default: true
        assignment_enabled:
          type: boolean
          title: Assignment Enabled
        reminder_enabled:
          type: boolean
          title: Reminder Enabled
        escalation_enabled:
          type: boolean
          title: Escalation Enabled
        priorities:
          items:
            type: string
            enum:
            - low
            - normal
            - high
            - urgent
          type: array
          maxItems: 4
          minItems: 0
          title: Priorities
        quiet_hours_enabled:
          type: boolean
          title: Quiet Hours Enabled
        quiet_start_minute:
          type: integer
          exclusiveMaximum: 1440.0
          minimum: 0.0
          title: Quiet Start Minute
        quiet_end_minute:
          type: integer
          exclusiveMaximum: 1440.0
          minimum: 0.0
          title: Quiet End Minute
        timezone:
          type: string
          maxLength: 64
          minLength: 1
          title: Timezone
        notification_preview:
          type: string
          enum:
          - hidden
          - title
          - full
          title: Notification Preview
          default: hidden
      type: object
      required:
      - push_enabled
      - assignment_enabled
      - reminder_enabled
      - escalation_enabled
      - priorities
      - quiet_hours_enabled
      - quiet_start_minute
      - quiet_end_minute
      - timezone
      title: NotificationPreferenceUpdate
    WorkspaceNotificationPolicyUpdate:
      properties:
        reminders_enabled:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Reminders Enabled
        reminder_minutes_before_expiry:
          anyOf:
          - type: integer
            maximum: 10080.0
            minimum: 1.0
          - type: 'null'
          title: Reminder Minutes Before Expiry
        escalations_enabled:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Escalations Enabled
        escalation_minutes_after_creation:
          anyOf:
          - type: integer
            maximum: 10080.0
            minimum: 1.0
          - type: 'null'
          title: Escalation Minutes After Creation
        escalation_priorities:
          anyOf:
          - items:
              type: string
              enum:
              - low
              - normal
              - high
              - urgent
            type: array
            maxItems: 4
            minItems: 0
          - type: 'null'
          title: Escalation Priorities
        default_assignee_user_id:
          anyOf:
          - type: string
            maxLength: 64
          - type: 'null'
          title: Default Assignee User Id
        notify_managers_on_assigned_actions:
          type: boolean
          title: Notify Managers On Assigned Actions
          default: false
      type: object
      title: WorkspaceNotificationPolicyUpdate
  securitySchemes:
    SourceBearer:
      type: http
      scheme: bearer
      description: Source API key (`axb_live_…`).
    UserBearer:
      type: http
      scheme: bearer
      description: User session bearer token.
    SessionCookie:
      type: apiKey
      in: cookie
      name: actionbox_session