openapi: 3.2.0 info: title: Fenergo Event Notifications API version: '1.0' description: 'Operations tagged EventNotifications across 2 of this provider''s published API definitions: fenergo-eventnotifications-v1-0-openapi.json, fenergo-eventnotifications-v2-0-openapi.json. Each path carries the servers of the definition it was published in.' servers: - url: /eventnotifications security: - Bearer: [] tags: - name: Event Notifications paths: /v1/{feedId}/next: get: tags: - Event Notifications summary: Get the next batch of event notifications description: This method will return next batch of event notifications parameters: - name: feedId in: path description: The feed identifier. Each tenant has by default 'all' feed which contains all notifications and feed per specifc event source (i.e. document, entitydata, journey, screening) required: true schema: type: string - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Fenergo.Nebula.EventNotifications.PublicApi.V1.GetNextBatchResult class represents batch result. content: text/plain: schema: $ref: '#/components/schemas/GetNextBatchResult' application/json: schema: $ref: '#/components/schemas/GetNextBatchResult' text/json: schema: $ref: '#/components/schemas/GetNextBatchResult' '204': description: No additional batches of event notifications found. operationId: getV1ByFeedIdNext x-operation-id-source: derived servers: - url: /eventnotifications /v1/{feedId}/{batchId}/complete: post: tags: - Event Notifications summary: Marks a batch as complete description: This method will mark a batch of notifications as completed. parameters: - name: feedId in: path description: The feed identifier. Each tenant has by default 'all' feed which contains all notifications and feed per specifc event source (i.e. document, entitydata, journey, screening) required: true schema: type: string - name: batchId in: path description: The batch identifier. Id of batch of event notifications which will be processed and set to complete after processing. required: true schema: type: string - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: OK operationId: postV1ByFeedIdByBatchIdComplete x-operation-id-source: derived servers: - url: /eventnotifications /v2/{feedId}/discardAll: put: tags: - Event Notifications summary: Discards all messages in queue for specific feed operationId: DiscardAll parameters: - name: feedId in: path description: The feed identifier. Each tenant has by default 'all' feed which contains all notifications and feed per specific event source (i.e. document, entitydata, journey, screening) required: true schema: type: string - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Messages discarded correctly servers: - url: /eventnotifications /v2/{feedId}/next: get: tags: - Event Notifications summary: Get the next batch of event notifications description: This method will return next batch of event notifications operationId: GetNext parameters: - name: feedId in: path description: The feed identifier. Each tenant has by default 'all' feed which contains all notifications and feed per specific event source (i.e. document, entitydata, journey, screening) required: true schema: type: string - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Fenergo.Nebula.EventNotifications.PublicApi.V2.GetNextBatchResult class represents batch result. content: text/plain: schema: $ref: '#/components/schemas/GetNextBatchResult' application/json: schema: $ref: '#/components/schemas/GetNextBatchResult' text/json: schema: $ref: '#/components/schemas/GetNextBatchResult' '204': description: No additional batches of event notifications found. servers: - url: /eventnotifications /v2/event-notification-types: get: tags: - Event Notifications summary: List all available event notification types description: This method will list all available event notification types. operationId: ListEventNotificationTypes parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: Fenergo.Nebula.EventNotifications.Utils.Dto.ListEventNotificationTypesResponse class containing event notification types results. content: text/plain: schema: $ref: '#/components/schemas/ListEventNotificationTypesResponse' application/json: schema: $ref: '#/components/schemas/ListEventNotificationTypesResponse' text/json: schema: $ref: '#/components/schemas/ListEventNotificationTypesResponse' servers: - url: /eventnotifications /v2/{feedId}/{batchId}/complete: post: tags: - Event Notifications summary: Marks a batch as complete description: This method will mark a batch of notifications as completed. parameters: - name: feedId in: path description: The feed identifier. Each tenant has by default 'all' feed which contains all notifications and feed per specifc event source (i.e. document, entitydata, journey, screening) required: true schema: type: string - name: batchId in: path description: The batch identifier. Id of batch of event notifications which will be processed and set to complete after processing. required: true schema: type: string - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: OK operationId: postV2ByFeedIdByBatchIdComplete x-operation-id-source: derived servers: - url: /eventnotifications components: schemas: GetNextBatchResult: type: object properties: batchId: type: - string - 'null' description: The batch identifier. example: 3e6195b4-3246-483f-83a8-f1725bd20c1c notifications: type: - array - 'null' items: $ref: '#/components/schemas/EventNotification' description: The collection of notifications. moreAvailable: type: boolean description: 'Indicates whether there are more batches on the server. Clients can check this to decide to perform an immediate requests or pause until the next polling interval.' example: true additionalProperties: false description: Represents a batch of notifications EventNotification: type: object properties: id: type: - string - 'null' description: 'The notification identifier. If a duplicate event notification occurs, it will have the same identifier as the previous instance.' example: f2a609e5-3f1d-467b-93ff-8839777c3026 eventType: type: - string - 'null' description: An event notification type in the format of "source:event". e.g. "entitydate:created". example: entitydata:created when: type: string description: When the notification was raised. format: date-time example: '2021-05-05T10:19:17.3157953+00:00' tenantId: type: - string - 'null' description: The tenant identifer associated with the notification. example: 501339c8-89a4-4021-b1d9-b23ed0257fa5 causationId: type: - string - 'null' description: Id that caused the notification, typically the ID of the resource/event correlationId: type: - string - 'null' description: A correlation identifier if there is one url: type: - string - 'null' description: A URL to get the resource the notification is related to. example: entitydataquery/api/entity/{id} payload: description: Payload of the notification additionalProperties: false description: Represents an event notification. ListEventNotificationTypesResponse: type: object properties: eventTypes: type: - array - 'null' items: $ref: '#/components/schemas/EventNotificationTypeDto' additionalProperties: false EventNotificationTypeDto: type: object properties: eventType: type: - string - 'null' title: type: - string - 'null' example: {} additionalProperties: false EventNotification_2: type: object properties: id: type: - string - 'null' description: 'The notification identifier. If a duplicate event notification occurs, it will have the same identifier as the previous instance.' example: f2a609e5-3f1d-467b-93ff-8839777c3026 eventType: type: - string - 'null' description: An event notification type in the format of "source:event". e.g. "entitydate:created". example: entitydata:created when: type: string description: When the notification was raised. format: date-time example: '2021-05-05T10:19:17.3157953+00:00' tenantId: type: - string - 'null' description: The tenant identifer associated with the notification. example: 501339c8-89a4-4021-b1d9-b23ed0257fa5 causationId: type: - string - 'null' description: Id that caused the notification, typically the ID of the resource/event correlationId: type: - string - 'null' description: A correlation identifier if there is one relativeUrl: type: - string - 'null' description: A URL to get the resource the notification is related to. example: entitydataquery/api/entity/{id} payload: description: Payload of the notification additionalProperties: false description: Represents an event notification. securitySchemes: Bearer: type: apiKey description: Please insert JWT with Bearer into field name: Authorization in: header x-refined-from: - fenergo-eventnotifications-v1-0-openapi.json - fenergo-eventnotifications-v2-0-openapi.json