Developer documentation for Celonis APIs

The Celonis Developer Center contains additional resources for developers such as API reference docs, schemas, requirements, tutorials and FAQs. Use the resources below to learn how to connect any of these Celonis APIs to your data in the Celonis Platform.

Standard Data Ingestion API

The Standard Data Ingestion API allows you to push real-time data to the Celonis Platform using your existing IT systems. This AWS S3 compatible API operates on events and notifications that get triggered whenever a new file reaches the API where it is automatically picked it up and processed to a data pool.

Before using the Standard Data Ingestion API, check the links below to review your options for:

Deciding when to use the Standard Data Ingestion API versus using a Celonis extractor.
Comparing the benefits of using the Standard Data ingestion API to the potential implications.
Watching a demo video showing how to push data to the Celonis Platform using the Standard Data Ingestion API.

Data Push API

Note

It is recommended that you use the Standard Data Ingestion API to push your data into the Celonis Platform.

The Data Push API provides an easy way to create, execute, and monitor the micro-batch jobs used to transfer data into the Celonis Platform. Once the data is available in the Celonis Platform, you can transform, analyze and work with it as you would with a Celonis-provided extractor. Use the links below to access the Developer Center in order to:

Download the open API specifications for the Data Push API.
Check out what you need to know before you begin using the Data Push API.
Test the various Data Push schemas used in the Celonis Platform.
See an example of the Data Push API written in Python.

Process Intelligence APIs

The Process Intelligence APIs allow customers to embed actionable intelligence into third-party platforms where end users may benefit from Celonis Intelligence insights. Use the links below to access the Developer Center in order to:

Learn more about the Process Intelligence API family.
Download the open API specifications for the Knowledge Model API, Event Subscription API, or AI API.
View and test schemas for Knowledge Models and data defined in the Celonis Platform.
Review the prerequisites for using the Knowledge Model API and how to authenticate your requests.
Discover and subscribe to business triggers using the Event Subscription API to receive spontaneous notifications of events.
Use the AI API to connect your Celonis Process Copilots with external chat tools such as Slack or Microsoft Teams.

Celonis Usage APIs

Use Audit Log API to query the audit logs for a Celonis Platform team and then use the extracted data to create a Studio View.
Query the assigned permissions for a Celonis Platform team using the Permissions API and use the exported permissions data to create new data models.
Check the platform adoption statistics for your team in the Celonis Platform with the Platform Adoption API.
Manage user identities across various cloud-based applications, such as your source identity system and your Celonis Platform team, using the System for Cross-domain Identity Management (SCIM) protocol.
The Team API allows for the querying of the data for a Celonis Platform team, such as the list of members assigned to the team or the login history for members of this team during a specified date range.

Symbio Process Manager APIs

These APIs are used to generate, retrieve, update and delete Symbio elements from within the Celonis Platform:

Learn to use the BPMN API to generate a BPML file for a given element or import a specific BPMN to an endpoint.
Use the Data API to retrieve data with pagination or for a specific ID, as well as create, update and delete elements.
Retrieve information about a specific facet or all facets of a certain type in Symbio using the Facets API.
By using the File API, you can retrieve, create, update or delete files in Symbio.
Take advantage of the Stereotypes API to retrieve, create, update, or delete stereotypes in Symbio.

Other Celonis API functionality

Learn to use the Audit Log, Team Login History and Platform Adoption APIs with your applications and create extractors to pull detailed information from your team into Studio.
Use the Data Job Execution API to execute a data job and query the status of existing data jobs using an OAuth client.
Perform a complete or partial reload of your data models to ensure that the latest data from your source system is available by utilizing the Process Data Model API.