{"componentChunkName":"component---src-templates-simple-markdown-js","path":"/process-intelligence-apis/subscription-api/api-reference/try-it/","matchPath":"","result":{"data":{"markdownRemark":{"html":"<h1 style=\"position:relative;\"><a href=\"#try-it\" aria-label=\"try it permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a><div class=\"hidden-anchor\" id=\"try-it\"></div>Try it!</h1>\n<p>If after reading the documentation you  want to try the Subscription API, we have prepared a\ndemo environment that anyone can access. Authentication is required, but any token\nthat you pass should work, so no need to get a User or Application key in advance. </p>\n<p>To show how this environment works, we will use Postman, but you can use any other REST client.</p>\n<p>The URL where this API can be located is: <a href=\"https://16abf815-424c-413e-b92d-6c6f8fc633cd.remockly.com/intelligence/api\">https://16abf815-424c-413e-b92d-6c6f8fc633cd.remockly.com/intelligence/api</a>. Keep in mind that\nfor real production environments, the URL typically ends with <code class=\"language-text\">/intelligence/api</code> and not <code class=\"language-text\">/api</code>.</p>\n<h2 style=\"position:relative;\"><a href=\"#1-create-a-new-http-request\" aria-label=\"1 create a new http request permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a><div class=\"hidden-anchor\" id=\"1-create-a-new-http-request\"></div>1. Create a new HTTP Request</h2>\n<p>Let's start this Tutorial by creating a new HTTP Request in Postman (File > New > HTTP Request). Make sure that you have\nselected a GET operation and paste the URL for the API next to it: <a href=\"https://16abf815-424c-413e-b92d-6c6f8fc633cd.remockly.com/intelligence/api\">https://16abf815-424c-413e-b92d-6c6f8fc633cd.remockly.com/intelligence/api</a>.</p>\n<p><span\n      class=\"gatsby-resp-image-wrapper\"\n      style=\"position: relative; display: block; margin-left: auto; margin-right: auto; max-width: 910px; \"\n    >\n      <span\n    class=\"gatsby-resp-image-background-image\"\n    style=\"padding-bottom: 25%; position: relative; bottom: 0; left: 0; background-image: url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAAFCAIAAADKYVtkAAAACXBIWXMAAAsTAAALEwEAmpwYAAAApElEQVQY021PSQ7DIAzkFb1VivGSEAMBcuxP2o/12p/WoDaKqo5GlhdmsJ2qtta2bau1WlI7Ss6ZmYgQ0Z/pPaiuGqPEXfebSykvy5JSMmUpxZSte3QXc1z+YJag1/vz8ni5llOMKiLEhEYkZpZZ7FNLLMKAH4ADHHBtThhnEYDJRn7EPhL2XTXBpzPZFSGE/mbQbFNc3dcVzuy3/nY8Eh3lWAbeGCIuCrZbui8AAAAASUVORK5CYII='); background-size: cover; display: block;\"\n  ></span>\n  <img\n        class=\"gatsby-resp-image-image\"\n        alt=\"Create a new HTTP Request\"\n        title=\"Create a new HTTP Request\"\n        src=\"/static/6f1df9989f0fc1744c4b5f617098d209/c6bbc/mock-step1.png\"\n        srcset=\"/static/6f1df9989f0fc1744c4b5f617098d209/d4770/mock-step1.png 228w,\n/static/6f1df9989f0fc1744c4b5f617098d209/379c3/mock-step1.png 455w,\n/static/6f1df9989f0fc1744c4b5f617098d209/c6bbc/mock-step1.png 910w,\n/static/6f1df9989f0fc1744c4b5f617098d209/71ee9/mock-step1.png 1081w\"\n        sizes=\"(max-width: 910px) 100vw, 910px\"\n        style=\"width:100%;height:100%;margin:0;vertical-align:middle;position:absolute;top:0;left:0;\"\n        loading=\"lazy\"\n      />\n    </span></p>\n<h2 style=\"position:relative;\"><a href=\"#2-configure-authentication\" aria-label=\"2 configure authentication permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a><div class=\"hidden-anchor\" id=\"2-configure-authentication\"></div>2. Configure authentication</h2>\n<p>Let's say we have our User API Key which is\n<code class=\"language-text\">NASDYUmYxMjItNmJJHuNYSdn7FkLThhasdhj89jM2ODVmOio090sadjkdkVnRFV3VVBtZ1jksadb8olJWXMSDHUASDik3UE5j</code>. Go to Postman\nand use this key for the Authentication header.\nClick on <code class=\"language-text\">Authorization</code> and select <code class=\"language-text\">Bearer Token</code> for the Type. For the token, paste the above key. </p>\n<p><span\n      class=\"gatsby-resp-image-wrapper\"\n      style=\"position: relative; display: block; margin-left: auto; margin-right: auto; max-width: 910px; \"\n    >\n      <span\n    class=\"gatsby-resp-image-background-image\"\n    style=\"padding-bottom: 36.84210526315789%; position: relative; bottom: 0; left: 0; background-image: url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAAHCAIAAACHqfpvAAAACXBIWXMAAAsTAAALEwEAmpwYAAAApUlEQVQY06WOUQ7CIBBEOYhRYGGlLNCWjxqTNj2Af97/MJ1qGmuMX33ZkNlhh0U1TSwitW8lSZSVlFLOGSLGyMzuB3Le3h6X+1OtjdZsTRIJIaDF2bxAGNp/c11hprPXJyWppNJL6XLbIeCcx7b3HIS1FiJsIAfHAOtQihyTD8QBn4GJzbjWO4ZhmOd5mqZxHGutRGQ2lNH6U3/Yv7X3lTmAcgdYAMdNPP87ZmCTAAAAAElFTkSuQmCC'); background-size: cover; display: block;\"\n  ></span>\n  <img\n        class=\"gatsby-resp-image-image\"\n        alt=\"Configure authentication\"\n        title=\"Configure authentication\"\n        src=\"/static/238ba56bebc02c0f5b7852c35bedc88c/c6bbc/mock-step2.png\"\n        srcset=\"/static/238ba56bebc02c0f5b7852c35bedc88c/d4770/mock-step2.png 228w,\n/static/238ba56bebc02c0f5b7852c35bedc88c/379c3/mock-step2.png 455w,\n/static/238ba56bebc02c0f5b7852c35bedc88c/c6bbc/mock-step2.png 910w,\n/static/238ba56bebc02c0f5b7852c35bedc88c/302a4/mock-step2.png 1080w\"\n        sizes=\"(max-width: 910px) 100vw, 910px\"\n        style=\"width:100%;height:100%;margin:0;vertical-align:middle;position:absolute;top:0;left:0;\"\n        loading=\"lazy\"\n      />\n    </span></p>\n<h2 style=\"position:relative;\"><a href=\"#3-get-the-list-of-knowledge-models\" aria-label=\"3 get the list of knowledge models permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a><div class=\"hidden-anchor\" id=\"3-get-the-list-of-knowledge-models\"></div>3. Get the list of Knowledge Models</h2>\n<p>Now we should be ready to start getting some information such as the full list of Knowledge Models. For that,\nyou need to add '/knowledge-models' at the end of the URL. As we can see, there is one Knowledge Model with the id\n<code class=\"language-text\">open-purchase-requisition.purchase-requisition-km</code> and named <code class=\"language-text\">Purchase Requisition KM</code>. As we can tell by the name, this\nKnowledge Model is giving us information about Purchases that happened in the company.</p>\n<p><span\n      class=\"gatsby-resp-image-wrapper\"\n      style=\"position: relative; display: block; margin-left: auto; margin-right: auto; max-width: 910px; \"\n    >\n      <span\n    class=\"gatsby-resp-image-background-image\"\n    style=\"padding-bottom: 48.68421052631579%; position: relative; bottom: 0; left: 0; background-image: url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAAKCAIAAAA7N+mxAAAACXBIWXMAAAsTAAALEwEAmpwYAAABFklEQVQoz41R7VEEIQylC/+5kBBI+DzWO7ULG7EHe7Myw+7eeeM4o+FNJoQ8kgem9S5JxhiXy+VJ7TxN43Vd991pDLm3lIRgeft4eP80o1cW8YGQFB6990QUgt8CTVrndizWWnBXeBu7iSFqkbVHhQNQr+Q9uGUAUbvCNQngcmIDqBmcO13b2eKc9t85N+/JR+GZ13pEQAIfzOvLc6m11JJqbq2pfhYO5LfrDihHZwFCVTcFBg8x5342nKSPdhotF06Z1W9B5BTkDiw/QLWKmUMDkD5iKT1xz9wScyTtoQMgqiK3YZ/iO7YAZgqAqUn5HINE2jhH3e2pf4VRKtdexqp3PdoDi/uDdpB1vl2EdrP/4xy/hfgFz7tYKS/jzTIAAAAASUVORK5CYII='); background-size: cover; display: block;\"\n  ></span>\n  <img\n        class=\"gatsby-resp-image-image\"\n        alt=\"Get list of Knowledge Models\"\n        title=\"Get list of Knowledge Models\"\n        src=\"/static/e79039b2e9fcc0a3ddf14acba15068ac/c6bbc/mock-step3.png\"\n        srcset=\"/static/e79039b2e9fcc0a3ddf14acba15068ac/d4770/mock-step3.png 228w,\n/static/e79039b2e9fcc0a3ddf14acba15068ac/379c3/mock-step3.png 455w,\n/static/e79039b2e9fcc0a3ddf14acba15068ac/c6bbc/mock-step3.png 910w,\n/static/e79039b2e9fcc0a3ddf14acba15068ac/38a65/mock-step3.png 1075w\"\n        sizes=\"(max-width: 910px) 100vw, 910px\"\n        style=\"width:100%;height:100%;margin:0;vertical-align:middle;position:absolute;top:0;left:0;\"\n        loading=\"lazy\"\n      />\n    </span></p>\n<h2 style=\"position:relative;\"><a href=\"#4-get-triggers-for-a-knowledge-model\" aria-label=\"4 get triggers for a knowledge model permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a><div class=\"hidden-anchor\" id=\"4-get-triggers-for-a-knowledge-model\"></div>4. Get triggers for a Knowledge Model</h2>\n<p>Imagine you want to retrieve all the triggers within a Knowledge Model. This is possible just adding the Knowledge Model id,\nfor example <code class=\"language-text\">open-purchase-requisition.purchase-requisition-km-base</code> and later appending <code class=\"language-text\">/triggers</code> to the URL.</p>\n<p><span\n      class=\"gatsby-resp-image-wrapper\"\n      style=\"position: relative; display: block; margin-left: auto; margin-right: auto; max-width: 910px; \"\n    >\n      <span\n    class=\"gatsby-resp-image-background-image\"\n    style=\"padding-bottom: 39.03508771929825%; position: relative; bottom: 0; left: 0; background-image: url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAAICAYAAAD5nd/tAAAACXBIWXMAAAsTAAALEwEAmpwYAAAA8ElEQVQoz52RTXIEIQiFvYnYouJPjbNLbpAj5CS5R278Ak6ny6pJFsniKxAQeeiYGTlnlFIw51x+jPHC8pd/2qSxxBGeaN2Z8w65vaLNF7ioiVorWu9orWGMga6+xfoZM3/VnL7ZIoLjOBRCzA3z/RPl7QNONFGkrAmbFtt5J4QA0kl2vPcgTwhXzD9iWuuskVRZmG8SeZO8Y82X5JQQE1+wnr9X5UyqSF2BpJi1hvai9/QEUXhMvUP2EK8VqOSMNjpuXXAfOmmxT2KdNv0A/47dyQmu6oJFSSki2/hs8o5/opJLG6h9nIulpw/4C7aKL9w05Oto1BoVAAAAAElFTkSuQmCC'); background-size: cover; display: block;\"\n  ></span>\n  <img\n        class=\"gatsby-resp-image-image\"\n        alt=\"Get the triggers for a knowledge model\"\n        title=\"Get the triggers for a knowledge model\"\n        src=\"/static/1c51533c2d37da90ad29a750c6dfc0d7/c6bbc/mock-step9.png\"\n        srcset=\"/static/1c51533c2d37da90ad29a750c6dfc0d7/d4770/mock-step9.png 228w,\n/static/1c51533c2d37da90ad29a750c6dfc0d7/379c3/mock-step9.png 455w,\n/static/1c51533c2d37da90ad29a750c6dfc0d7/c6bbc/mock-step9.png 910w,\n/static/1c51533c2d37da90ad29a750c6dfc0d7/46115/mock-step9.png 1290w\"\n        sizes=\"(max-width: 910px) 100vw, 910px\"\n        style=\"width:100%;height:100%;margin:0;vertical-align:middle;position:absolute;top:0;left:0;\"\n        loading=\"lazy\"\n      />\n    </span></p>\n<h2 style=\"position:relative;\"><a href=\"#5-creating-a-new-subscription\" aria-label=\"5 creating a new subscription permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a><div class=\"hidden-anchor\" id=\"5-creating-a-new-subscription\"></div>5. Creating a new subscription</h2>\n<p>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\ntrigger id <code class=\"language-text\">abc-123-bad-123</code> to the previous URL. Ensure also the URL is requesting a new subscription appending <code class=\"language-text\">subscriptions</code> to the end of the URI.</p>\n<p>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\nsubscription.</p>\n<p><span\n      class=\"gatsby-resp-image-wrapper\"\n      style=\"position: relative; display: block; margin-left: auto; margin-right: auto; max-width: 910px; \"\n    >\n      <span\n    class=\"gatsby-resp-image-background-image\"\n    style=\"padding-bottom: 38.15789473684211%; position: relative; bottom: 0; left: 0; background-image: url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAAICAYAAAD5nd/tAAAACXBIWXMAAAsTAAALEwEAmpwYAAABBUlEQVQoz5WSS27DMAxEdRNb/78dx0CKOqtue4feowfKPaekbCdZGEWyeBiJoAYjSsIYgxgjcs6IadW25lpKjXQA9+wavEH5/kX5uUHsxVwKxnHAUAtqrSi0L3WACwlaa8I8ocFB1jqhFHScYKYvCB8iYvDw1sBSkzPcrNuaVVKzUhJKPkF7uekd2ZFxB1FPAy7LgvOYUZNHaTjU7Om6DiHYl4nRQxiKnE8z6jQjetcScoqu79G/Caduhto6WOebmd6u8y98eDPYeRha2wa8DtlQUd0bjmiPQPNWhKYzikOQWgrFHmJZLlg+CdLr9QPzmV66BPoS7pBMM84035QfmnjudIb5Awm76Bi9LgNaAAAAAElFTkSuQmCC'); background-size: cover; display: block;\"\n  ></span>\n  <img\n        class=\"gatsby-resp-image-image\"\n        alt=\"Creating a new subscription\"\n        title=\"Creating a new subscription\"\n        src=\"/static/8c0c395a5eb7b4addb37c45dacba39cf/c6bbc/mock-step10.png\"\n        srcset=\"/static/8c0c395a5eb7b4addb37c45dacba39cf/d4770/mock-step10.png 228w,\n/static/8c0c395a5eb7b4addb37c45dacba39cf/379c3/mock-step10.png 455w,\n/static/8c0c395a5eb7b4addb37c45dacba39cf/c6bbc/mock-step10.png 910w,\n/static/8c0c395a5eb7b4addb37c45dacba39cf/46115/mock-step10.png 1290w\"\n        sizes=\"(max-width: 910px) 100vw, 910px\"\n        style=\"width:100%;height:100%;margin:0;vertical-align:middle;position:absolute;top:0;left:0;\"\n        loading=\"lazy\"\n      />\n    </span></p>\n<h2 style=\"position:relative;\"><a href=\"#6-get-the-list-of-subscriptions\" aria-label=\"6 get the list of subscriptions permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a><div class=\"hidden-anchor\" id=\"6-get-the-list-of-subscriptions\"></div>6. Get the list of subscriptions</h2>\n<p>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\nsubscriptions, just in case any of them is failing, or it is paused or suspended.</p>\n<p>Also, the <code class=\"language-text\">id</code> of the subscription is something important to know, since that information is required for updating, pausing, resuming, unsubscribing and\nthe manual fetching of the data.</p>\n<p><span\n      class=\"gatsby-resp-image-wrapper\"\n      style=\"position: relative; display: block; margin-left: auto; margin-right: auto; max-width: 910px; \"\n    >\n      <span\n    class=\"gatsby-resp-image-background-image\"\n    style=\"padding-bottom: 43.85964912280702%; position: relative; bottom: 0; left: 0; background-image: url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAAJCAYAAAAywQxIAAAACXBIWXMAAAsTAAALEwEAmpwYAAABD0lEQVQoz4WRa3LDIAyEuQlG4m1iJ+3kDr1DL9K79LBbCccOTdPJj28EBrTatWHPqLWgtSa19jquc84gIjDzEzyYJvh8wvL5jfTxBVNKQYgBMUWEIDVGpJSOqg+naYJz7kAFxr0S2hWcLzA+eFhrO/pQ0bX3vj981kyH6E33M6lMFuQsjE4VZBpFmzi3qW/N3SGyQ3LexSQqUtsyEMvehygiDHN5W3E+SwZrw7I0rMuM05zFbpD8nlNK/EObS39jNL9UZ1TZzHKZSCzQZo1ulfk3/dvAeNeo/1hmrO9XLKJSRSCIlZ0o1viW5Ss0KhOzjFqqTLVl1xU1/IGe6cNffeTeUJoVsewm+1J9XP/X8AfDsP/S0nge7QAAAABJRU5ErkJggg=='); background-size: cover; display: block;\"\n  ></span>\n  <img\n        class=\"gatsby-resp-image-image\"\n        alt=\"Get all the subscriptions\"\n        title=\"Get all the subscriptions\"\n        src=\"/static/f45063b2241b34493915f80829ac3476/c6bbc/mock-step11.png\"\n        srcset=\"/static/f45063b2241b34493915f80829ac3476/d4770/mock-step11.png 228w,\n/static/f45063b2241b34493915f80829ac3476/379c3/mock-step11.png 455w,\n/static/f45063b2241b34493915f80829ac3476/c6bbc/mock-step11.png 910w,\n/static/f45063b2241b34493915f80829ac3476/46115/mock-step11.png 1290w\"\n        sizes=\"(max-width: 910px) 100vw, 910px\"\n        style=\"width:100%;height:100%;margin:0;vertical-align:middle;position:absolute;top:0;left:0;\"\n        loading=\"lazy\"\n      />\n    </span></p>\n<h2 style=\"position:relative;\"><a href=\"#7-update-a-subscription\" aria-label=\"7 update a subscription permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a><div class=\"hidden-anchor\" id=\"7-update-a-subscription\"></div>7. Update a subscription</h2>\n<p>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 <code class=\"language-text\">id</code> <code class=\"language-text\">abc-123-bad-123</code>\nto the <code class=\"language-text\">subscriptions</code> URI, and define a valid name and a valid callback URI.</p>\n<p><span\n      class=\"gatsby-resp-image-wrapper\"\n      style=\"position: relative; display: block; margin-left: auto; margin-right: auto; max-width: 910px; \"\n    >\n      <span\n    class=\"gatsby-resp-image-background-image\"\n    style=\"padding-bottom: 43.85964912280702%; position: relative; bottom: 0; left: 0; background-image: url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAAJCAYAAAAywQxIAAAACXBIWXMAAAsTAAALEwEAmpwYAAABFElEQVQoz32R623DMAyENUljSaTeklMkQIAu0B06SWfpslfSTgM7hfPjA2VSPh1J4z0h54xaK0pZo6K5UgqqoJGZ4ZyD934DwbsJlDrG1w/i5zfMIqY/tYoxOrrE1toi2voAhbQIWcXaQ3h8wJcrDMeIGBMiE0heVVTgj8kK0yQci1mtn94knkQwBMzXG0YtCOTBgttcdi9cPaNjMCUHnC8XXG43vA9puyVoLkVGSrzGLekFUjdEBCfDpRAXd/7esj3i4cjd2XQjdRNTRlhICDGLOC8PWOf/4RyBZUle5u5lVArJmcVMkD0QB5jzuWOe24PRC1qNYp+eWlq/s4wjZ94j+VplsdqytRP2qHW72/Qe+wKHX3oZAoqsOgkKAAAAAElFTkSuQmCC'); background-size: cover; display: block;\"\n  ></span>\n  <img\n        class=\"gatsby-resp-image-image\"\n        alt=\"Updating a subscription\"\n        title=\"Updating a subscription\"\n        src=\"/static/1666d79512409a6372a021d2d5f5bc98/c6bbc/mock-step12.png\"\n        srcset=\"/static/1666d79512409a6372a021d2d5f5bc98/d4770/mock-step12.png 228w,\n/static/1666d79512409a6372a021d2d5f5bc98/379c3/mock-step12.png 455w,\n/static/1666d79512409a6372a021d2d5f5bc98/c6bbc/mock-step12.png 910w,\n/static/1666d79512409a6372a021d2d5f5bc98/46115/mock-step12.png 1290w\"\n        sizes=\"(max-width: 910px) 100vw, 910px\"\n        style=\"width:100%;height:100%;margin:0;vertical-align:middle;position:absolute;top:0;left:0;\"\n        loading=\"lazy\"\n      />\n    </span></p>\n<h2 style=\"position:relative;\"><a href=\"#8-pause-a-subscription\" aria-label=\"8 pause a subscription permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a><div class=\"hidden-anchor\" id=\"8-pause-a-subscription\"></div>8. Pause a subscription</h2>\n<p>If you have the id of a subscription, you can pause it to stop receiving events. Just ensure you append the <code class=\"language-text\">id</code> <code class=\"language-text\">abc-123-bad-123</code>\nto the <code class=\"language-text\">subscriptions</code> URI, and also append to the command <code class=\"language-text\">pause</code> at the end</p>\n<p><span\n      class=\"gatsby-resp-image-wrapper\"\n      style=\"position: relative; display: block; margin-left: auto; margin-right: auto; max-width: 910px; \"\n    >\n      <span\n    class=\"gatsby-resp-image-background-image\"\n    style=\"padding-bottom: 43.85964912280702%; position: relative; bottom: 0; left: 0; background-image: url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAAJCAYAAAAywQxIAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAwUlEQVQoz62QyXHDMAxF2YlJLBRXJYcUkR7ciHtxsT8EHSsaxTfr8AbE8sE/cCqKlBNqrSilzGjknLfcosHMBwRMHpI6Pq53LN83uJzHcB20irV39NbQdogMEdNcEEKA9x5hh58EcPkCpU84VYXGCIsmNtED2t5ENHMT2gwpg2TAjzjdDqfkL3DrOlz1utHacJvtA0aM8o9l0ZeUkkZfzSFjT1TBsbZHhiM9MGu/Pee3O7yPncf93ewcTlt4usPnwh+/mf8obD8fawAAAABJRU5ErkJggg=='); background-size: cover; display: block;\"\n  ></span>\n  <img\n        class=\"gatsby-resp-image-image\"\n        alt=\"Pausing a subscription\"\n        title=\"Pausing a subscription\"\n        src=\"/static/9d2adebfa4ca804f6275feca6af29249/c6bbc/mock-step13.png\"\n        srcset=\"/static/9d2adebfa4ca804f6275feca6af29249/d4770/mock-step13.png 228w,\n/static/9d2adebfa4ca804f6275feca6af29249/379c3/mock-step13.png 455w,\n/static/9d2adebfa4ca804f6275feca6af29249/c6bbc/mock-step13.png 910w,\n/static/9d2adebfa4ca804f6275feca6af29249/46115/mock-step13.png 1290w\"\n        sizes=\"(max-width: 910px) 100vw, 910px\"\n        style=\"width:100%;height:100%;margin:0;vertical-align:middle;position:absolute;top:0;left:0;\"\n        loading=\"lazy\"\n      />\n    </span></p>\n<h2 style=\"position:relative;\"><a href=\"#9-resume-a-subscription\" aria-label=\"9 resume a subscription permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a><div class=\"hidden-anchor\" id=\"9-resume-a-subscription\"></div>9. Resume a subscription</h2>\n<p>If you have the id of a paused subscription, you can resume it to start receiving events. Just ensure you append the <code class=\"language-text\">id</code> <code class=\"language-text\">abc-123-bad-123</code>\nto the <code class=\"language-text\">subscriptions</code> URI, and also append to the command <code class=\"language-text\">resume</code> at the end</p>\n<p><span\n      class=\"gatsby-resp-image-wrapper\"\n      style=\"position: relative; display: block; margin-left: auto; margin-right: auto; max-width: 910px; \"\n    >\n      <span\n    class=\"gatsby-resp-image-background-image\"\n    style=\"padding-bottom: 43.85964912280702%; position: relative; bottom: 0; left: 0; background-image: url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAAJCAYAAAAywQxIAAAACXBIWXMAAAsTAAALEwEAmpwYAAAA2klEQVQoz5WRURKCMAxEcxOgTVqgLfrjHbyDF/EuHnZNqqiA48jHmzQJ2S4pCQuGYUDOGeM41jifU0oVOxvMDO/9B5q7FtwXTJcb4vkKMjERQYgBEjSGgBjjK5qIc64KdF1XsXw+z0g+wfVHkIm1bbugaZqXkOU2MEermYm1KKtT1zWgT6H1rd+o3614zGtP+2ROWPjpyG/cLlEnunMnHo7feNOwurqmw1RQSsI0pRpL1gcYou7V6x55Q4zyFZuxPtngEsa29obVkayotWePfv/iPmzH9M9D7OEOWGj+ytcrKysAAAAASUVORK5CYII='); background-size: cover; display: block;\"\n  ></span>\n  <img\n        class=\"gatsby-resp-image-image\"\n        alt=\"Resuming a subscription\"\n        title=\"Resuming a subscription\"\n        src=\"/static/0cfec8dec001b7f571f60660f75bf7b4/c6bbc/mock-step14.png\"\n        srcset=\"/static/0cfec8dec001b7f571f60660f75bf7b4/d4770/mock-step14.png 228w,\n/static/0cfec8dec001b7f571f60660f75bf7b4/379c3/mock-step14.png 455w,\n/static/0cfec8dec001b7f571f60660f75bf7b4/c6bbc/mock-step14.png 910w,\n/static/0cfec8dec001b7f571f60660f75bf7b4/46115/mock-step14.png 1290w\"\n        sizes=\"(max-width: 910px) 100vw, 910px\"\n        style=\"width:100%;height:100%;margin:0;vertical-align:middle;position:absolute;top:0;left:0;\"\n        loading=\"lazy\"\n      />\n    </span></p>\n<h2 style=\"position:relative;\"><a href=\"#10-unsubscribe\" aria-label=\"10 unsubscribe permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a><div class=\"hidden-anchor\" id=\"10-unsubscribe\"></div>10. Unsubscribe</h2>\n<p>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 <code class=\"language-text\">id</code> <code class=\"language-text\">abc-123-bad-123</code>\nto the <code class=\"language-text\">subscriptions</code> URI.</p>\n<p><span\n      class=\"gatsby-resp-image-wrapper\"\n      style=\"position: relative; display: block; margin-left: auto; margin-right: auto; max-width: 910px; \"\n    >\n      <span\n    class=\"gatsby-resp-image-background-image\"\n    style=\"padding-bottom: 43.85964912280702%; position: relative; bottom: 0; left: 0; background-image: url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAAJCAYAAAAywQxIAAAACXBIWXMAAAsTAAALEwEAmpwYAAAA00lEQVQoz5WRXRLCIAyEc5MWCGD5qb54B+/gRbyLh10JaGup4+jDNwGSLGEhZxnTNCGlhBBCja91jLEia2sttNYwxrzBMHoEHzLm6x3+cgOFIibFzrsWnYP3fonMXIWUUgv9XrDpDH04gURkHMcNwzAsQrLvxeRFvSiXSbUaQO9C/a2fqHUdrb/kSp5kEi4+tonMbtotqtVZA80rRjS4eUzHOSPniHmONeYUECZf/DTFR97hvf2I9EiepHELY3+2wmUi21HPnjn6/sT/EI/pl4/4hwcZnP6yHGk4PgAAAABJRU5ErkJggg=='); background-size: cover; display: block;\"\n  ></span>\n  <img\n        class=\"gatsby-resp-image-image\"\n        alt=\"Unsubscribe\"\n        title=\"Unsubscribe\"\n        src=\"/static/2e9d6689c5f3042b96bc56ba5d97b18a/c6bbc/mock-step15.png\"\n        srcset=\"/static/2e9d6689c5f3042b96bc56ba5d97b18a/d4770/mock-step15.png 228w,\n/static/2e9d6689c5f3042b96bc56ba5d97b18a/379c3/mock-step15.png 455w,\n/static/2e9d6689c5f3042b96bc56ba5d97b18a/c6bbc/mock-step15.png 910w,\n/static/2e9d6689c5f3042b96bc56ba5d97b18a/46115/mock-step15.png 1290w\"\n        sizes=\"(max-width: 910px) 100vw, 910px\"\n        style=\"width:100%;height:100%;margin:0;vertical-align:middle;position:absolute;top:0;left:0;\"\n        loading=\"lazy\"\n      />\n    </span></p>\n<h2 style=\"position:relative;\"><a href=\"#11-get-unsent-events-of-a-failing-subscription-manually\" aria-label=\"11 get unsent events of a failing subscription manually permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a><div class=\"hidden-anchor\" id=\"11-get-unsent-events-of-a-failing-subscription-manually\"></div>11. Get unsent events of a failing subscription manually</h2>\n<p>In case of a failing subscription, it is possible to get the unsent events manually.</p>\n<p>Just ensure that you have the <code class=\"language-text\">id</code> <code class=\"language-text\">abc-123-bad-123</code> of the failing subscription, and include the <code class=\"language-text\">events</code> path to the <code class=\"language-text\">subscriptions</code> URI.</p>\n<p><span\n      class=\"gatsby-resp-image-wrapper\"\n      style=\"position: relative; display: block; margin-left: auto; margin-right: auto; max-width: 910px; \"\n    >\n      <span\n    class=\"gatsby-resp-image-background-image\"\n    style=\"padding-bottom: 43.85964912280702%; position: relative; bottom: 0; left: 0; background-image: url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAAJCAYAAAAywQxIAAAACXBIWXMAAAsTAAALEwEAmpwYAAAA+ElEQVQoz42SXVbEIAyF2UmBJKUUmDoP7sE9uBH34mJjEmFOO6jHh++EvxsuCY6QOOfMtVbe993iGJdSDB2fSSlxjJEBkCF6xq3x7f2T09sHO01GRLymlWmVuK4mGBERuxguhBAuUH3luL2w02Te+wvLsjwS6VwFY0/X1ITGc0IUpzEs7EzQDz/f+htDE05a72Vd9hxqHcTNtyOY3F6cm0Ow8xGhM/Rkrt1xSEGPyrdWuAm1SuGz1JBA6ogTSUk0YRrZc6VJwvvdJkTYI8iNYHECZ8ZZjU5tUi6c28G7dLpu0u3exb+e/xOqcfoFYv8KCPEBPHXxv3wBgiD/7BCkaogAAAAASUVORK5CYII='); background-size: cover; display: block;\"\n  ></span>\n  <img\n        class=\"gatsby-resp-image-image\"\n        alt=\"Get events manually\"\n        title=\"Get events manually\"\n        src=\"/static/eb581b4bdc125efe268a55249848beea/c6bbc/mock-step16.png\"\n        srcset=\"/static/eb581b4bdc125efe268a55249848beea/d4770/mock-step16.png 228w,\n/static/eb581b4bdc125efe268a55249848beea/379c3/mock-step16.png 455w,\n/static/eb581b4bdc125efe268a55249848beea/c6bbc/mock-step16.png 910w,\n/static/eb581b4bdc125efe268a55249848beea/46115/mock-step16.png 1290w\"\n        sizes=\"(max-width: 910px) 100vw, 910px\"\n        style=\"width:100%;height:100%;margin:0;vertical-align:middle;position:absolute;top:0;left:0;\"\n        loading=\"lazy\"\n      />\n    </span></p>\n<p>Keep in mind that this is just a simple demo. Features like Filter, Filter Expressions and many others are not supported.\nHowever, 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,\nwe recommend you to have a look at our <a href=\"/process-intelligence-apis/knowledge-model-api/tutorials/learning/exploring-schema/\">Tutorials</a>. </p>","headings":[{"value":"Try it!","depth":1},{"value":"1. Create a new HTTP Request","depth":2},{"value":"2. Configure authentication","depth":2},{"value":"3. Get the list of Knowledge Models","depth":2},{"value":"4. Get triggers for a Knowledge Model","depth":2},{"value":"5. Creating a new subscription","depth":2},{"value":"6. Get the list of subscriptions","depth":2},{"value":"7. Update a subscription","depth":2},{"value":"8. Pause a subscription","depth":2},{"value":"9. Resume a subscription","depth":2},{"value":"10. Unsubscribe","depth":2},{"value":"11. Get unsent events of a failing subscription manually","depth":2}]},"contentItem":{"data":{"lastModified":"2025-10-08T17:20:52.000Z","enableToc":null,"disableLastModified":null,"tocMaxDepth":null,"requestLogin":false}},"siteConfig":{"enableToc":false,"disableLastModified":false,"tocMaxDepth":4}},"pageContext":{"matchPath":"","id":"9ea37705-48a8-5f8a-8b32-80150f7dc014__redocly content/process-intelligence-apis/subscription-api/api-reference/try-it/","seo":{"title":"Try it!","description":null,"image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"process-intelligence-apis/subscription-api/api-reference/try-it.md","pageBaseUrl":"/process-intelligence-apis/subscription-api/api-reference/try-it","type":"markdown","toc":{"enable":true,"maxDepth":4,"headings":[{"depth":1,"value":"Try it!","id":"try-it"},{"depth":2,"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"}]},"data":{"title":""},"catalogInfo":null,"link":"/process-intelligence-apis/subscription-api/api-reference/try-it/","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"]}