Skip to content
Process Intelligence APIs
/
/Webhook/
Receive asynchronous even...

Receive asynchronous events from Subscription API

Request

Receive asynchronous events

Security
BearerAuth or ApiKeyAuth
Bodyapplication/jsonrequired

Event from a Record or Data Model

subscriberIdstring

Subscriber's Unique identifier as a SUID

Example:"abc-123-bad-123"
triggerIdstring

Trigger's Unique identifier as a SUID

Example:"abc-123-bad-123"
offsetnumber

Position of the event in the subscription Queue source

Example:1234
creationDatestring, (date-time)

Date of the event creation

Example:"2023-07-21T17:32:28Z"
eventobject(signalEventDTO)
POST
/api/events
const resp = await fetch(
  `https://developer.celonis.com/_mock/process-intelligence-apis/subscription-api/outbound-api-reference/openapi/outbound-openapi/api/events`,
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      Authorization: 'Bearer <YOUR_JWT_HERE>'
    },
    body: JSON.stringify({
      subscriberId: 'abc-123-bad-123',
      triggerId: 'abc-123-bad-123',
      offset: 1234,
      creationDate: '2023-07-21T17:32:28Z',
      event: {
        id: 'abc-123-bad-123',
        identifier: 1,
        typedIdentifier: 2,
        fields: [
          {
            id: 'CASE_NUMBER',
            value: 'my_value',
            type: 'STRING',
            isIdentifier: true
          }
        ]
      }
    })
  }
);

const data = await resp.json();
console.log(data);

Responses

Bad Request.

Bodyapplication/problem+json
titlestring

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4). This definition was copied from https://datatracker.ietf.org/doc/html/rfc7807

statusinteger

The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem. This definition was copied from https://datatracker.ietf.org/doc/html/rfc7807

detailstring

The details of the Error

errorCodestring

Unique Identifier of the Error

typestring

A URI reference [RFC3986] that identifies the problem type. This definition was copied from https://datatracker.ietf.org/doc/html/rfc7807

Response
{
  "title": "string",
  "status": 0,
  "detail": "string",
  "errorCode": "string",
  "type": "string"
}