Articles in this section

Available Celonis APIs

When you configure an export, import, other type of flow step using the prebuilt Celonis connector, you can select any of the API operations listed below, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the Celonis API documentation. You can also create a composite endpoint for this application in HTTP mode.

Resource

API endpoint

Export

Import

Data

Get a list of KM record data

X

 

Get a list of KM data

X

 

Data push API

Create a new data push job in a data pool

 

X

List running data push jobs for a data pool

X

 

Add chunk to a data push job

 

X

List the chunks of a data push job

X

 

Delete rows from a table via a data push job

 

X

Get the status of a data push job

X

 

Execute a data push job

 

X

Delete a data push job

 

X

Cancel a data push job

 

X

Schema

Get a list of KMs

X

 

Get the top level KM details

X

 

Get a list of KM filters

X

 

Get a list of KM records schema

X

 

Get the top level KM record schema details

X

 

Get a list of KM KPI's schema

X

 

Subscription

Get a list of KM triggers

X

 

Create a subscription for the trigger

 

X

Get a list of subscriptions

X

 

Unsubscribe from a trigger removing all the data for the subscription

 

X

Update a subscription

 

X

Retrieve the next page of events if they were not forwarded due to a failed subscription

 

X

Pause the subscription to stop receiving events

 

X

Resume paused subscription to start receiving events again

 

X

Resume paused subscription to start receiving new events, discarding history events

 

X