Opal Activities API
## Activities OverviewIn Opal, "activities" encompass both things like someone adding an asset to content and also someone sending a chat message. In the user interface, these are called "Chat & Activity" but the underlying resource is always an `activity` record.This API currently supports _retrieving_ all types of activity (see the `activity_types` endpoint to retrieve a list of supported types). It only supports _creating_ chat activity.## CheckpointsThe `checkpoints` endpoints are how activities get marked as read for users. The idea is that any activity older than the most recent checkpoint has been seen by the user.## User @mentionsUser mentions are represented in the plaintext body of activity messages. You can create them (or interpret them) using the following syntax:```@[{{user name}}](user:{{user_id}})```The double-bracketed `{{user name}}` should be replaced with the user's full name (not their "username" or email) and `{{user_id}}` should be replaced with the user's _integer_ id value (not a UUID). Do not use quotation marks or spaces (except between the parts of a user's name). For example, `[John Doe](user:1234)`.
Opal Activities API is one of 79 APIs that Opal publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Activities. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 5 operations across 3 paths. It is described by OpenAPI 3.2.0, at version 2.0.0.
Requests are made against a single base URL, https://login.ouropal.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Opal Activities API declares
2 security schemes
for authenticating requests.
It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 1 scope.
An API key is passed in the header as Session-Token (api_key).
oauth2— This API uses OAuth 2.0 with the authorization code grant flow. You can find more detailed authentication instructions in the [Authentication Strategies](/api/…api_key— (Deprecated) This API also supports authentication via an API or session token set in the request headers.
Paths & Operations 5
Across 3 paths, the API surfaces 5 operations — 3 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.
Activities Overview In Opal, "activities" encompass both things like someone adding an asset to content and also someone sending a chat message. In the user interface, these are c…
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Opal 12
Other APIs Opal publishes across the network.
This is an independent, third-party profile of Opal Activities API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.