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

Managing an event subscription

\n

In this tutorial we will guide you through the different subscription management endpoints.

\n

List of Knowledge Models

\n

As you saw in the Getting Started page, you can get the full list of Knowledge Models that you\nhave access to, creating a request to https://<team>.<cluster>.celonis.cloud/intelligence/api/knowledge-models (remember\nthat you need to replace <team> and <cluster> with your own values).

\n

\n \n \n

\n

List of Knowledge Model Triggers

\n

You can get the full list of triggers that a Knowledge Model has, creating a request to\nhttps://<team>.<cluster>.celonis.cloud/intelligence/api/knowledge-models/<km_id>/triggers. For this URL, you will need to\nreplace the <km_id> with the Knowledge Model id that you got from the previous endpoint.

\n

\n \n

Resuming a Subscription

\n

To resume a paused subscription, you need to consume the next endpoint.

\n
\n
\n
Copy
\n
Copied
\n
\n 
PATCH\n/subscriptions/{{subscription-id}}/resume
\n
\n

subscription-id refers to the subscription to resume. It must exist in the API.

\n

Once the subscription is resumed, it will forward new events generated by Celonis Platform, as well as the events that were pending when the subscription was paused.

\n

Unsubscribing

\n

To remove an existing subscription you need to consume the next endpoint.

\n
\n
\n
Copy
\n
Copied
\n
\n 
DELETE\n/subscriptions/{{subscription-id}}
\n
\n

subscription-id refers to the subscription to unsubscribe. It must exist in the API.

\n

Once this action is executed, the subscription will be no longer visible at Celonis Platform, and all its data is removed from the API.

\n

Manual extraction (reconcile endpoint)

\n

If the subscription is failing, in the meanwhile the subscription is fixed, is possible to manually extract the data from Celonis Platform in short batches.\nThis is what is called the Reconciliation.

\n

To manually extract data, you need to consume the next endpoint.

\n
\n
\n
Copy
\n
Copied
\n
\n 
PATCH\n/subscriptions/{{subscription-id}}/events
\n
\n

subscription-id refers to the subscription to reconcile. It must exist in the API.

\n

Once this action is executed, the next 50 events will be taken. Bear in mind this action will remove those events from the system.

\n
\n
\n
Copy
\n
Copied
\n
\n 
{\n    \"pageSize\": 2,\n    \"total\": 0,\n    \"content\": [\n        {\n            \"subscriptionId\": \"XXX-YYY-ZZZZ\",\n            \"triggerId\": \"97185b79-d6e9-4425-bbee-225627533149\",\n            \"signal\": \"{\\\"id\\\":\\\"a8ffef1d-aba0-4520-ae1a-02cecc7b7e4e\\\",\\\"recordIdentifier\\\":\\\"800A3000531000\\\",\\\"typedRecordIdentifier\\\":\\\"800A3000531000\\\",\\\"attributes\\\":[{\\\"attributeId\\\":\\\"ATTRIBUTE_1\\\",\\\"signalId\\\":\\\"a8ffef1d-aba0-4520-ae1a-02cecc7b7e4e\\\",\\\"value\\\":null,\\\"columnType\\\":\\\"STRING\\\"}],\\\"creationDate\\\":1699010395821}\"\n        },\n        {\n            \"subscriptionId\": \"XXX-YYY-ZZZZ\",\n            \"triggerId\": \"97185b79-d6e9-4425-bbee-225627533149\",\n            \"signal\": \"{\\\"id\\\":\\\"8cf03551-471c-41f0-a85c-e88646eef354\\\",\\\"recordIdentifier\\\":\\\"80000000130071000\\\",\\\"typedRecordIdentifier\\\":\\\"80000000130071000\\\",\\\"attributes\\\":[{\\\"attributeId\\\":\\\"ATTRIBUTE_1\\\",\\\"signalId\\\":\\\"8cf03551-471c-41f0-a85c-e88646eef354\\\",\\\"value\\\":\\\"D1\\\",\\\"columnType\\\":\\\"STRING\\\"}],\\\"creationDate\\\":1699010395821}\"\n        }\n    ]\n}
\n
\n

pageSize refers to the events returned in the page.\ntotal refers to the total events still at the API.\ncontent events as raw JSON.

\n

Replay a subscription

\n

To replay the subscription to receive events from a position, you need to consume the next endpoint.

\n
\n
\n
Copy
\n
Copied
\n
\n 
PATCH\n/subscriptions/{{subscription-id}}/replay?fromOffset=10
\n
\n

subscription-id refers to the subscription to replay. It must exist in the API.

\n

Optionally, you can specify the offset from receiving past events. Just append the fromOffset url parameter with a value between 0 and the latest known position.

\n

Untransferred data

\n

Untransferred data means the data unable to forward to the consumer but saved at the API to retry later. The data can be saved at the API under two circunstances:

\n\n

Untransferred data can be manually extracted using the reconcile endpoint.\nBut for active subscriptions with data remaining in the API, every 10 minutes our API will retry to forward the data to the consumer.

\n

Finally, the data is kept at the API for 7 days, after the period of time all the pending data will be discarded.

","headings":[{"value":"Managing an event subscription","depth":1},{"value":"List of Knowledge Models","depth":2},{"value":"List of Knowledge Model Triggers","depth":2},{"value":"Creating a new Subscription","depth":2},{"value":"Updating an existing Subscription","depth":2},{"value":"Pausing a Subscription","depth":2},{"value":"Resuming a Subscription","depth":2},{"value":"Unsubscribing","depth":2},{"value":"Manual extraction (reconcile endpoint)","depth":2},{"value":"Replay a subscription","depth":2},{"value":"Untransferred data","depth":2}]},"contentItem":{"data":{"lastModified":"2025-01-28T15:05:42.000Z","enableToc":null,"disableLastModified":null,"tocMaxDepth":null,"requestLogin":false}},"siteConfig":{"enableToc":false,"disableLastModified":false,"tocMaxDepth":4}},"pageContext":{"matchPath":"","id":"9848f3d7-7645-5d26-9182-0c4c55392028__redocly content/process-intelligence-apis/subscription-api/tutorials/learning/managing-subscription/","seo":{"title":"Managing an event subscription","description":null,"image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"process-intelligence-apis/subscription-api/tutorials/learning/managing-subscription.md","pageBaseUrl":"/process-intelligence-apis/subscription-api/tutorials/learning/managing-subscription","type":"markdown","toc":{"enable":true,"maxDepth":4,"headings":[{"depth":1,"value":"Managing an event subscription","id":"managing-an-event-subscription"},{"depth":2,"value":"List of Knowledge Models","id":"list-of-knowledge-models"},{"depth":2,"value":"List of Knowledge Model Triggers","id":"list-of-knowledge-model-triggers"},{"depth":2,"value":"Creating a new Subscription","id":"creating-a-new-subscription"},{"depth":2,"value":"Updating an existing Subscription","id":"updating-an-existing-subscription"},{"depth":2,"value":"Pausing a Subscription","id":"pausing-a-subscription"},{"depth":2,"value":"Resuming a Subscription","id":"resuming-a-subscription"},{"depth":2,"value":"Unsubscribing","id":"unsubscribing"},{"depth":2,"value":"Manual extraction (reconcile endpoint)","id":"manual-extraction-reconcile-endpoint"},{"depth":2,"value":"Replay a subscription","id":"replay-a-subscription"},{"depth":2,"value":"Untransferred data","id":"untransferred-data"}]},"data":{"title":""},"catalogInfo":null,"link":"/process-intelligence-apis/subscription-api/tutorials/learning/managing-subscription/","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"]}