Okareo Notifications API
Configure notifications and view notification history.
Configure notifications and view notification history.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/okareo:okareo-notifications-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a 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: 3.2.0
info:
title: Okareo Notifications API
version: 0.1.0
description: Configure notifications and view notification history.
servers:
- url: https://api.okareo.com
tags:
- name: Notifications
description: Configure notifications and view notification history.
paths:
/v0/setup_filter_group_notification:
post:
tags:
- Notifications
summary: Setup Filter Group Notification
description: 'Set up or manage a notification for a specific filter group.
Args:
request: The HTTP request
filter_group_id: The ID of the filter group to set up notifications for
notification_type: The type of notification channel ("slack" or "email" only for now)
status: Whether to enable ("on") or disable ("off") notifications
cooldown_seconds: The cooldown period in seconds for notifications (default of 0 will use default cooldowns of 24 hours (email) and 1 minute (slack)).
project_id: UUID of the project to scope the notification setup to (defaults to Global)
Returns:
dict: Details about the notification configuration'
operationId: setup_filter_group_notification_v0_setup_filter_group_notification_post
parameters:
- name: filter_group_id
in: query
required: true
schema:
type: string
format: uuid
title: Filter Group Id
- name: notification_type
in: query
required: true
schema:
type: string
title: Notification Type
- name: status
in: query
required: true
schema:
type: string
title: Status
- name: cooldown_seconds
in: query
required: false
schema:
type: integer
default: 0
title: Cooldown Seconds
- name: project_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Project Id
- name: api-key
in: header
required: true
schema:
type: string
title: Api-Key
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response Setup Filter Group Notification V0 Setup Filter Group Notification Post
'400':
description: Input data is incorrect
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
description: Okareo API token has failed authentication
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Data is not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'422':
description: Input data is invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v0/filter_group_notifications:
get:
tags:
- Notifications
summary: Get Filter Group Notifications
description: 'Get all notification settings for filter groups in the current project.
This endpoint retrieves information about all filter groups with notification
configurations, including their enabled status and channel types (email/slack).
Args:
request: The HTTP request
project_id: UUID of the project to read settings for (defaults to Global)
Returns:
list: A list of dictionaries containing notification settings for each filter group'
operationId: get_filter_group_notifications_v0_filter_group_notifications_get
parameters:
- name: project_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Project Id
- name: api-key
in: header
required: true
schema:
type: string
title: Api-Key
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
type: object
additionalProperties: true
title: Response Get Filter Group Notifications V0 Filter Group Notifications Get
'400':
description: Input data is incorrect
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
description: Okareo API token has failed authentication
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Data is not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'422':
description: Input data is invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v0/notifications:
get:
tags:
- Notifications
summary: Get All Notification
description: Retrieve a specific notification configuration.
operationId: get_all_notification__v0_notifications_get
parameters:
- name: project_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Project Id
- name: api-key
in: header
required: true
schema:
type: string
title: Api-Key
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'400':
description: Input data is incorrect
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
description: Okareo API token has failed authentication
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Data is not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'422':
description: Input data is invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
put:
tags:
- Notifications
summary: Update Notification Settings
description: Update notification settings for the current project.
operationId: update_notification_settings_v0_notifications_put
parameters:
- name: project_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Project Id
- name: api-key
in: header
required: true
schema:
type: string
title: Api-Key
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'400':
description: Input data is incorrect
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
description: Okareo API token has failed authentication
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Data is not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'422':
description: Input data is invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
delete:
tags:
- Notifications
summary: Delete Notification History Config
description: Update notification settings for the current project.
operationId: delete_notification_history_config_v0_notifications_delete
parameters:
- name: project_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Project Id
- name: api-key
in: header
required: true
schema:
type: string
title: Api-Key
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'400':
description: Input data is incorrect
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
description: Okareo API token has failed authentication
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Data is not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'422':
description: Input data is invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v0/notification_history:
get:
tags:
- Notifications
summary: Get Notification History
description: 'Get notification history for the current project and organization.
Only returns records where contents is populated.
Args:
request: The HTTP request
project_id: UUID of the project to read history for (defaults to Global)
Returns:
list: A list of notification history records with populated contents'
operationId: get_notification_history_v0_notification_history_get
parameters:
- name: project_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Project Id
- name: api-key
in: header
required: true
schema:
type: string
title: Api-Key
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
type: object
additionalProperties: true
title: Response Get Notification History V0 Notification History Get
'400':
description: Input data is incorrect
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
description: Okareo API token has failed authentication
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Data is not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'422':
description: Input data is invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v0/generate_slack_auth_url:
post:
tags:
- Notifications
summary: Generate Slack Auth Url
description: 'Generates a Slack authentication URL with a temporary authorization token.
Args:
request: The HTTP request containing project_id in the body
db: Database session
Returns:
dict: Contains the Slack authentication URL'
operationId: generate_slack_auth_url_v0_generate_slack_auth_url_post
parameters:
- name: api-key
in: header
required: true
schema:
type: string
title: Api-Key
requestBody:
required: true
content:
application/json:
schema:
type: object
additionalProperties: true
title: Project Data
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: object
additionalProperties: true
title: Response Generate Slack Auth Url V0 Generate Slack Auth Url Post
'400':
description: Input data is incorrect
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
description: Okareo API token has failed authentication
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Data is not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'422':
description: Input data is invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
components:
schemas:
ErrorResponse:
properties:
detail:
type: string
title: Detail
type: object
required:
- detail
title: ErrorResponse