This documentation describes how to interact with the Celonis Event Subscription REST API.
\nThis API is used to discover business triggers, subscribe to them, manage event subscriptions and emit spontaneous events.
\nThe steps that the Event Subscription API consumer follows to start receiving spontaneous events are:
\nSKIP_ERRORS\n);\nThis workflow is depicted in the following sequence diagram:
\n\nThe subscription state transitions are depicted below:
\n\nThis is how each subscription operation affects status transitions:
\nActive\n and an internal queue is provisioned to hold the produced events (\nState Transition: [Start]-->Active\n).\nActive\n as long as the events are successfully emitted to the callback webhook.\noffset\n, \nlatestSucceedEvent\n and \nlatestSucceedOffset\n are updated.\nFailed\n (\nState Transition: Active-->Failed\n).\nSKIP_ERRORS\n, then \nfailed\n or \nrejected\n events are \nskipped and permanently lost\n. Otherwise, the events remain in queue until callback webhook restoration.\nActive\n (\nState Transition: Failed-->Active\n).\nFailed\n status for longer than a configurable period (8 hours), then the subscription goes to state \nSuspended\n. The auto-recovery process \nstops\n, the event queue is \ndestroyed\n and all events are lost (\nState Transition: Failed-->Suspended\n).\nRejected\n (\nState Transition: Active-->Rejected\n). The error codes indicating event rejection are:\n| Rejection Status Codes | \nRejection Messages | \n
|---|---|
400 | \nBad Request | \n
401 | \nUnauthorized | \n
402 | \nPayment Required | \n
403 | \nForbidden | \n
404 | \nNot Found | \n
405 | \nMethod Not Allowed | \n
406 | \nNot Acceptable | \n
410 | \nGone | \n
413 | \nPayload Too Large | \n
414 | \nURI Too Long | \n
415 | \nUnsupported Media Type | \n
422 | \nUnprocessable Content | \n
431 | \nRequest Header Fields Too Large (RFC 6585) | \n
451 | \nUnavailable For Legal Reasons (RFC 7725) | \n
Failed\n or \nSuspended\n subscription or to change their callback details (\nState Transition: Failed-->Active\n or \nSuspended-->Active\n).\nActive\n subscription. Then it goes to state \nPaused\n and stops emitting events. The events remain in queue (\nState Transition: Active-->Paused\n).\nPaused\n subscription can be resumed, goes back to state \nActive\n and starts either from the offset it was paused or it starts without history by emitting only fresh events (\nState Transition: Paused-->Active\n).\nSuspended\n, the subscription goes to state \nActive\n and starts re-emission from the offset specified in the request (\nState Transition: any state-->Active\n).\nNote: Each subscription has an owner (the creator) and its lifecycle can be managed only by the owner or an administrator.
\nWe value your feedback and are constantly striving to improve our APIs.
\nIf you have encountered any problems or have any suggestions for new features, please take a moment to share your\nthoughts with us through\nthis form.
\nYour input is important to us and will help us make our APIs even better.
\nThank you for your time and support!
","headings":[{"value":"Event Subscription API","depth":1},{"value":"Goals","depth":2},{"value":"How it works","depth":2},{"value":"Further Considerations","depth":2},{"value":"Feedback","depth":2}]},"contentItem":{"data":{"lastModified":"2025-09-17T16:35:01.000Z","enableToc":null,"disableLastModified":null,"tocMaxDepth":null,"requestLogin":false}},"siteConfig":{"enableToc":false,"disableLastModified":false,"tocMaxDepth":4}},"pageContext":{"matchPath":"","id":"950b8da8-c16c-5e02-89de-898991c6c659__redocly content/process-intelligence-apis/subscription-api/overview/","seo":{"title":"Event Subscription API","description":null,"image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"process-intelligence-apis/subscription-api/overview.md","pageBaseUrl":"/process-intelligence-apis/subscription-api/overview","type":"markdown","toc":{"enable":true,"maxDepth":4,"headings":[{"depth":1,"value":"Event Subscription API","id":"event-subscription-api"},{"depth":2,"value":"Goals","id":"goals"},{"depth":2,"value":"How it works","id":"how-it-works"},{"depth":2,"value":"Further Considerations","id":"further-considerations"},{"depth":2,"value":"Feedback","id":"feedback"}]},"data":{"title":""},"catalogInfo":null,"link":"/process-intelligence-apis/subscription-api/overview/","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"]}