Yoobic Notifications API
Notifications provide information about the internal notifications sent to users in the application.### Fields| Field | Type | Required | Readonly | OrderBy | Description ||----------------------|:--------------:|:--------:|:--------:|:-------:|---------------------------||`notification_id` | string | x | x | | Unique id of the notification ||`title` | string | x | | | The title of notification ||`mode` | string | | | | The way in which the notification is sent. Possible values (`push`, `email`, `all`) ||`body` | string | x | | | Notification body ||`user_ids` | array | x | | | Target user ids to send the notification ||`group_ids` | array | | | | Send notification to all users in group_ids, but not to users from imbricated groups ||`badge_type` | string | | x | | Specifies which badge in the Operations or Boost app should be incremented for recipients of this notification ||`sender_id` | string | | x | | Unique id of the user triggering the notification ||`push_recipients` | number | | x | | Number of recipients ||`entity_type` | string | | | | The entity's type for which the notification was created. Possible values (`missions`, `news`, `campaigns`) ||`entity_id` | string | | | | The unique id of the entity ||`created_date` | date | | x | | Creation date ||`updated_date` | date | | x | x | Last update date |**Important**:- `entity_type` and `entity_id` are used to redirect the user once he/she click on the notification.- `group_ids` is used only when creating the notification. Therefore, it won't be provided on the response. Instead, all the recipients.- There is a limit of 50k notifications. If you need to send more than this, you can split the recipients in separate requests targetting different groups.
Yoobic Notifications API is one of 41 APIs that Yoobic publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Notifications. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a changelog.
This API exposes 5 operations across 5 paths, and defines 1 schema. It is described by OpenAPI 3.0.0.
Requests are made against a single base URL, https://.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Yoobic Notifications API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (oauth2) using the authorizationCode flow.
Paths & Operations 5
Across 5 paths, the API surfaces 5 operations — 4 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Notifications provide information about the internal notifications sent to users in the application. Fields | Field | Type | Required | Readonly | OrderBy | Description | |-------…
Schemas 1
The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Default_Header (1 property). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Yoobic 12
Other APIs Yoobic publishes across the network.