{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Try it!","description":"API documentation for Celonis APIs.","siteUrl":"https://developer.celonis.com/","keywords":"celonis developer portal, celonis apis, celonis api reference docs","lang":"en-US","llmstxt":{"hide":false,"description":"Celonis API documentation","sections":[{"title":"API Docs","description":"Available Celonis API Docs","includeFiles":["**/*.md"],"excludeFiles":[]},{"title":"API Specs","description":"All Celonis API specifications","includeFiles":["**/openapi.yaml"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"try-it","__idx":0},"children":["Try it!"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If after reading the documentation you  want to try the Subscription API, we have prepared a"," ","demo environment that anyone can access. Authentication is required, but any token"," ","that you pass should work, so no need to get a User or Application key in advance."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To show how this environment works, we will use Postman, but you can use any other REST client."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The URL where this API can be located is: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://16abf815-424c-413e-b92d-6c6f8fc633cd.remockly.com/intelligence/api"]},". Keep in mind that"," ","for real production environments, the URL typically ends with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/intelligence/api"]}," and not ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"1-create-a-new-http-request","__idx":1},"children":["1. Create a new HTTP Request"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Let's start this Tutorial by creating a new HTTP Request in Postman (File > New > HTTP Request). Make sure that you have"," ","selected a GET operation and paste the URL for the API next to it: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://16abf815-424c-413e-b92d-6c6f8fc633cd.remockly.com/intelligence/api"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/mock-step1.a2d6032743d2d7ddaa4c957eac4d54246350eac78464761b5a776d164e8eca88.527729fc.png","alt":"Create a new HTTP Request"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"2-configure-authentication","__idx":2},"children":["2. Configure authentication"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Let's say we have our User API Key which is"," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NASDYUmYxMjItNmJJHuNYSdn7FkLThhasdhj89jM2ODVmOio090sadjkdkVnRFV3VVBtZ1jksadb8olJWXMSDHUASDik3UE5j"]},". Go to Postman"," ","and use this key for the Authentication header."," ","Click on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization"]}," and select ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Bearer Token"]}," for the Type. For the token, paste the above key."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/mock-step2.639caa743ba3d49f625a341eb4629a616b7d47b4c13c2e51e3bdb54dc60b019d.527729fc.png","alt":"Configure authentication"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"3-get-the-list-of-knowledge-models","__idx":3},"children":["3. Get the list of Knowledge Models"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Now we should be ready to start getting some information such as the full list of Knowledge Models. For that,"," ","you need to add '/knowledge-models' at the end of the URL. As we can see, there is one Knowledge Model with the id"," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["open-purchase-requisition.purchase-requisition-km"]}," and named ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Purchase Requisition KM"]},". As we can tell by the name, this"," ","Knowledge Model is giving us information about Purchases that happened in the company."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/mock-step3.76f688efe99b5c49be4b6f5065bea41e71f8e5b72d64d52180a5b4332acbcce5.527729fc.png","alt":"Get list of Knowledge Models"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"4-get-triggers-for-a-knowledge-model","__idx":4},"children":["4. Get triggers for a Knowledge Model"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Imagine you want to retrieve all the triggers within a Knowledge Model. This is possible just adding the Knowledge Model id,"," ","for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["open-purchase-requisition.purchase-requisition-km-base"]}," and later appending ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/triggers"]}," to the URL."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/mock-step9.c3a946703dd532ee8f30c5e8cbcd4a9dcae0379f87bedfe0c3c2399c66c2073c.527729fc.png","alt":"Get the triggers for a knowledge model"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"5-creating-a-new-subscription","__idx":5},"children":["5. Creating a new subscription"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Once you know the id of the trigger you want to use to create a subscription, you can create a new subscription just adding the"," ","trigger id ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["abc-123-bad-123"]}," to the previous URL. Ensure also the URL is requesting a new subscription appending ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subscriptions"]}," to the end of the URI."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Do not forget to give a name to the subscription, and a valid callback URI, and the system will return to you the id for that new"," ","subscription."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/mock-step10.731e954674cd8663e1627875672a6716036e563f24e1c3c5d748a50867556515.527729fc.png","alt":"Creating a new subscription"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"6-get-the-list-of-subscriptions","__idx":6},"children":["6. Get the list of subscriptions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Once you created the subscription, you can get all the subscriptions in the system, it is useful for example to check the status of your"," ","subscriptions, just in case any of them is failing, or it is paused or suspended."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Also, the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," of the subscription is something important to know, since that information is required for updating, pausing, resuming, unsubscribing and"," ","the manual fetching of the data."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/mock-step11.caac6eaf677927a45b1292e84592b4be61d644fa5715054bcc278eb36e0ed90e.527729fc.png","alt":"Get all the subscriptions"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"7-update-a-subscription","__idx":7},"children":["7. Update a subscription"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you have the id of a subscription, you can perform an update to change its name or its callback URI. Just ensure you append the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["abc-123-bad-123"]}," ","to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subscriptions"]}," URI, and define a valid name and a valid callback URI."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/mock-step12.819bf7f853e38fdcbfd6819674d079f114e322552fd288f4ea8b61ace31fd4a8.527729fc.png","alt":"Updating a subscription"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"8-pause-a-subscription","__idx":8},"children":["8. Pause a subscription"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you have the id of a subscription, you can pause it to stop receiving events. Just ensure you append the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["abc-123-bad-123"]}," ","to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subscriptions"]}," URI, and also append to the command ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pause"]}," at the end"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/mock-step13.4a117c067bcd26202155109b5b28453549d15846322db4bac42fe1706af805cd.527729fc.png","alt":"Pausing a subscription"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"9-resume-a-subscription","__idx":9},"children":["9. Resume a subscription"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you have the id of a paused subscription, you can resume it to start receiving events. Just ensure you append the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["abc-123-bad-123"]}," ","to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subscriptions"]}," URI, and also append to the command ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["resume"]}," at the end"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/mock-step14.35b8e79a8ce2693b13786da3991fe549c35d1a61bb21ad59081d786bd61f7049.527729fc.png","alt":"Resuming a subscription"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"10-unsubscribe","__idx":10},"children":["10. Unsubscribe"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you have the id of a paused subscription, you can unsubscribe it to remove the subscription from the system. Just ensure you append the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["abc-123-bad-123"]}," ","to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subscriptions"]}," URI."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/mock-step15.f6d620e0862e165bb0417f809db5d842c336ddf1be989b618dd790cb026df0cf.527729fc.png","alt":"Unsubscribe"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"11-get-unsent-events-of-a-failing-subscription-manually","__idx":11},"children":["11. Get unsent events of a failing subscription manually"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In case of a failing subscription, it is possible to get the unsent events manually."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Just ensure that you have the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["abc-123-bad-123"]}," of the failing subscription, and include the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["events"]}," path to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subscriptions"]}," URI."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/mock-step16.9752db17cc55f8c666dca065b480343d99e66768e4f74047c1c4b5d3711cf965.527729fc.png","alt":"Get events manually"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Keep in mind that this is just a simple demo. Features like Filter, Filter Expressions and many others are not supported."," ","However, we expect you now have a better understanding of how to use the Knowledge Model API. If you want to become more familiar with the API,"," ","we recommend you to have a look at our ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/process-intelligence-apis/knowledge-model-api/tutorials/learning/exploring-schema"},"children":["Tutorials"]},"."]}]},"headings":[{"value":"Try it!","id":"try-it","depth":1},{"value":"1. Create a new HTTP Request","id":"1-create-a-new-http-request","depth":2},{"value":"2. Configure authentication","id":"2-configure-authentication","depth":2},{"value":"3. Get the list of Knowledge Models","id":"3-get-the-list-of-knowledge-models","depth":2},{"value":"4. Get triggers for a Knowledge Model","id":"4-get-triggers-for-a-knowledge-model","depth":2},{"value":"5. Creating a new subscription","id":"5-creating-a-new-subscription","depth":2},{"value":"6. Get the list of subscriptions","id":"6-get-the-list-of-subscriptions","depth":2},{"value":"7. Update a subscription","id":"7-update-a-subscription","depth":2},{"value":"8. Pause a subscription","id":"8-pause-a-subscription","depth":2},{"value":"9. Resume a subscription","id":"9-resume-a-subscription","depth":2},{"value":"10. Unsubscribe","id":"10-unsubscribe","depth":2},{"value":"11. Get unsent events of a failing subscription manually","id":"11-get-unsent-events-of-a-failing-subscription-manually","depth":2}],"frontmatter":{"seo":{"title":"Try it!"}},"lastModified":"2026-03-06T16:57:22.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/process-intelligence-apis/subscription-api/api-reference/try-it","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}