{"componentChunkName":"component---src-templates-simple-markdown-js","path":"/process-intelligence-apis/subscription-api/get-started/getting-started/","matchPath":"","result":{"data":{"markdownRemark":{"html":"

Getting Started

\n

This page describes how to get started with the Subscription API in a simple way using Postman.

\n

Prerequisites

\n
    \n
  1. \nYou need to have a \nKnowledge Model\n available in your team with at least one \nKM Trigger\n.\n
    2. \n
  2. \nYou must request the activation of the API in your Celonis Platform Team to the account team.\n
    3. \n
  3. \nYou should establish a destination webhook at the 3P Platform that will be able to understand the \nsemantics of Celonis events\n.\n
    4. \n
  4. \nYou should make sure that you have the authentication token of the outbound webhook. You will need it when you create the subscription so that outbound events don’t get rejected as unauthorized.\n
    5. \n
\n

Inbound Direction

\n

Authentication

\n

The authentication options applicable to all Celonis APIs are described here.

\n

Authorization

\n
OAuth Scopes for Subscription API
\n

OAuth clients for Subscription API should be configured with the scope:

\n\n
Client Permissions for Subscription API
\n

You must set the right permissions and ensure the User API Key or the Application leveraged for authorization purposes has access to the Celonis Celonis Platform Studio package containing the Knowledge Model(s) and the Triggers you would like to access through Subscription API.

\n

You can grant access permissions by following these steps:

\n\n

Outbound Direction

\n

Callback Info

\n

Example of the request payload of the subscription is below:

\n
\n
\n
Copy
\n
Copied
\n
\n 
{\n   \"callbackInfo\": {\n       \"uri\": \"$destination-webhook-URL\",\n       \"protocol\": \"HTTPS\",\n       \"headers\": {\n           \"Authorization\": \"Bearer\" + $token\n       }\n   },\n    \"name\": \"$subcription-name\",\n   \"configurations\": [$optional-list-of-subscription-configurations]\n}
\n
\n\n

Outbound Authentication/Authorization to the 3P Platform

\n

Possible Authentication methods:

\n\n

Consuming the Subscription API

\n

Once you have completed the previous steps, you can start making requests to the API. For that you will use Postman (or any other REST client), which you should already have installed in our system.

\n
    \n
  1. \nGo to \nFile > New...\n and select \"HTTP Request\". Once you do this, you should see something like this:\n
    2. \n
\n

\n \n \n

\n

Inside the Content section, you will see a list of all your Knowledge Models. The Knowledge Models will be divided into pages. By default, the page size will be 50. If you have more than 50 Knowledge Models, you can navigate to\nthe following page, adding a \"page\" query parameter. The pages start at 0, so you can display the second page by setting a page value of 1.

\n

\n \n \n

\n

In this quick guide, you managed to create your first requests to Subscription API and discover the triggers to which consumers can subscribe.

\n

Please refer to the guidelines for subscription lifecycle management for more details and tutorials.

","headings":[{"value":"Getting Started","depth":1},{"value":"Prerequisites","depth":2},{"value":"Inbound Direction","depth":3},{"value":"Authentication","depth":4},{"value":"Authorization","depth":4},{"value":"OAuth Scopes for Subscription API","depth":5},{"value":"Client Permissions for Subscription API","depth":5},{"value":"Outbound Direction","depth":3},{"value":"Callback Info","depth":4},{"value":"Outbound Authentication/Authorization to the 3P Platform","depth":4},{"value":"Consuming the Subscription API","depth":2},{"value":"Getting the list of Knowledge Models","depth":3},{"value":"Getting the list of KM Triggers","depth":3}]},"contentItem":{"data":{"lastModified":"2025-10-07T17:03:39.000Z","enableToc":null,"disableLastModified":null,"tocMaxDepth":null,"requestLogin":false}},"siteConfig":{"enableToc":false,"disableLastModified":false,"tocMaxDepth":4}},"pageContext":{"matchPath":"","id":"1108f445-ab76-545a-b2ba-fc092de45bf7__redocly content/process-intelligence-apis/subscription-api/get-started/getting-started/","seo":{"title":"Getting Started","description":null,"image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"process-intelligence-apis/subscription-api/get-started/getting-started.md","pageBaseUrl":"/process-intelligence-apis/subscription-api/get-started/getting-started","type":"markdown","toc":{"enable":true,"maxDepth":4,"headings":[{"depth":1,"value":"Getting Started","id":"getting-started"},{"depth":2,"value":"Prerequisites","id":"prerequisites"},{"depth":3,"value":"Inbound Direction","id":"inbound-direction"},{"depth":4,"value":"Authentication","id":"authentication"},{"depth":4,"value":"Authorization","id":"authorization"},{"depth":5,"value":"OAuth Scopes for Subscription API","id":"oauth-scopes-for-subscription-api"},{"depth":5,"value":"Client Permissions for Subscription API","id":"client-permissions-for-subscription-api"},{"depth":3,"value":"Outbound Direction","id":"outbound-direction"},{"depth":4,"value":"Callback Info","id":"callback-info"},{"depth":4,"value":"Outbound Authentication/Authorization to the 3P Platform","id":"outbound-authenticationauthorization-to-the-3p-platform"},{"depth":2,"value":"Consuming the Subscription API","id":"consuming-the-subscription-api"},{"depth":3,"value":"Getting the list of Knowledge Models","id":"getting-the-list-of-knowledge-models"},{"depth":3,"value":"Getting the list of KM Triggers","id":"getting-the-list-of-km-triggers"}]},"data":{"title":""},"catalogInfo":null,"link":"/process-intelligence-apis/subscription-api/get-started/getting-started/","sidebarName":"celonis","isLanding":false,"showPrevButton":null,"showNextButton":null,"apiVersions":null,"apiVersionId":null,"isDefaultApiVersion":null}},"staticQueryHashes":["1123603147","1302185487","1344209882","1398840060","1520077861","1975142765","2667623876","2950305614","3240152602","3743992808","561138138"]}