Celonis Subscriptions API is one of 17 APIs that Celonis publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Subscriptions. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes
9 operations
across 8 paths,
and defines 14 schemas.
It is described by OpenAPI 3.0.0, at version v1.2.0.
Requests are made against a single base URL, https://30f873b4-88d4-49ba-b327-6f651d7b99e6.remockly.com.
9 operations8 paths14 schemas1 DELETE1 GET5 PATCH1 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Specification
OpenAPI 3.0.0
API Version
v1.2.0
Base URL
https://{team_domain}.{realm}.celonis.cloud
Authentication
HTTP Bearer, API Key
Resource Areas
1
Authentication & Security 2
Celonis Subscriptions API declares
2 security schemes
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (BearerAuth).
An API key is passed in the header as AppKey (ApiKeyAuth).
By default, every request must be authenticated.
Paths & Operations 9
Across 8 paths, the API surfaces 9 operations — 1 DELETE, 1 GET, 5 PATCH, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are subscriptionDTO (12 properties), eventDTO (5 properties), errorDTO (5 properties), schemaResultPage (4 properties). Each schema is shown below with its type and property counts.
eventFieldDTO
object
Fields Metadata for the event
4 properties
signalEventDTO
object
4 properties
eventDTO
object
Event stored at subscription data source
5 properties
schemaResultPage
object
4 properties
SignalResultPage
object
2 properties
callbackInfoDTO
object
1 property
subscriptionId
object
1 property
subscriptionDTO
object
Subscription schema
12 properties
callbackResumedInfoDTO
object
2 properties2 required
errorDTO
object
This [RFC7807] specification is to define common error formats for those applications that need one, so that they aren't required to define their own, or worse…
5 properties
configurations
array
Configuration for the Subscription
authErrorDTO
object
1 property
subscriptionRequest
object
Request with details to create the subscription
3 properties2 required
subscriptionResultPage
object
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
