{ "openapi": "3.0.1", "info": { "title": "Event Notifications Config Service", "description": "API documentation for the Event Notifications Config Service", "version": "0.0.34-SNAPSHOT" }, "servers": [ { "url": "https://api.boomi.com/event-notifications-config", "description": "US" }, { "url": "https://api.platform.gb.boomi.com/event-notifications-config/", "description": "GB" } ], "tags": [ { "name": "Destination Types", "description": "API for retrieving available destination types\n\n**Required Privileges**:\n\nEnsure you have the Event Notification Administrator role." }, { "name": "Log Levels", "description": "API for retrieving available log levels\n\n**Required Privileges**:\n\nEnsure you have the Event Notification Administrator role." }, { "name": "Subscriptions", "description": "API for operating on an accounts subscriptions\n\n**Required Privileges**:\n\nEnsure you have the Event Notification Administrator role.\n\n>**Note**: EMAIL destination type is not supported in the current release. Only EVENT_STREAMS is available." }, { "name": "Events", "description": "API for retrieving available events\n\n**Required Privileges**:\n\nEnsure you have the Event Notification Administrator role." }, { "name": "ESTopicAndSubscription", "description": "API for operating on an account's Event Streams topic and subscriptions\n\n**Required Privileges**:\n\nEnsure you have the Event Notification Administrator role." } ], "paths": { "/rest/v1/accounts/{accountId}/subscriptions": { "get": { "tags": [ "Subscriptions" ], "summary": "List all subscriptions for an account", "description": "Retrieves all event subscriptions associated with the specified account", "operationId": "listSubscribedEventsForAccount", "parameters": [ { "name": "accountId", "in": "path", "description": "The Boomi account ID associated with the subscriptions", "required": true, "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Page number for pagination", "required": false, "schema": { "type": "integer", "format": "int32" }, "example": 0 }, { "name": "pageSize", "in": "query", "description": "Number of items per page", "required": false, "schema": { "type": "integer", "format": "int32" }, "example": 20 }, { "name": "sortBy", "in": "query", "description": "Field to sort by", "required": false, "schema": { "type": "string" }, "example": "createdDate" }, { "name": "sortDirection", "in": "query", "description": "Sort direction (ASC or DESC)", "required": false, "schema": { "type": "string" }, "example": "DESC" } ], "responses": { "200": { "description": "Successfully retrieved subscriptions", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionWrapper" }, "example": { "subscriptions": [ { "subscriptionId": "123e4567-e89b-12d3-a456-426614174000", "eventName": "Atom.Status", "destinationType": "EMAIL", "logLevel": "ERROR", "accountId": "acct_12345", "destinationEmail": "user@example.com", "enabled": true, "createdDate": 1625097600000, "lastUpdatedDate": 1625184000000 }, { "subscriptionId": "223e4567-e89b-12d3-a456-426614174001", "eventName": "Atom.Status", "destinationType": "EVENT_STREAMS", "logLevel": "WARN", "accountId": "acct_12345", "eventStreamsEnvironment": "production", "eventStreamsTopic": "notifications-topic", "enabled": true, "createdDate": 1625097600000, "lastUpdatedDate": 1625184000000 } ] } } } }, "403": { "description": "Forbidden - Not authorized to access this account's subscriptions", "content": { "application/json": { "example": { "error": "Forbidden", "messages": [ "Access Denied" ], "path": "/rest/v1/accounts/acct_12345/subscriptions" } } } }, "404": { "description": "No subscriptions found for the account", "content": { "application/json": { "example": { "error": "Entity not found", "messages": [ "No subscriptions found for account acct_12345" ], "path": "/rest/v1/accounts/acct_12345/subscriptions" } } } }, "401": { "description": "Unauthorized - Authentication is required" }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "errorId": "62ccbcf6-6795-4e56-8868-cf34a9a833a1", "error": "Internal server error", "messages": [ "Could not open JPA EntityManager for transaction" ], "path": "/rest/v1/accounts/acct_12345/subscriptions" } } } } }, "security": [ { "bearer-auth": [] } ] }, "put": { "tags": [ "Subscriptions" ], "summary": "Update subscriptions for an account", "description": "Updates all subscriptions for the specified account. Creates subscriptions if none exist.", "operationId": "updateSubscriptions", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "description": "The Boomi account ID associated with the subscriptions" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionWrapper" } } }, "required": true }, "responses": { "201": { "description": "Subscriptions created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionWrapper" }, "example": { "subscriptions": [ { "subscriptionId": "123e4567-e89b-12d3-a456-426614174000", "eventName": "Atom.Status", "destinationType": "EMAIL", "logLevel": "ERROR", "accountId": "acct_12345", "destinationEmail": "user@example.com", "enabled": true, "createdDate": 1625097600000, "lastUpdatedDate": 1625184000000 }, { "subscriptionId": "223e4567-e89b-12d3-a456-426614174001", "eventName": "Atom.Status", "destinationType": "EVENT_STREAMS", "logLevel": "WARN", "accountId": "acct_12345", "eventStreamsEnvironment": "production", "eventStreamsTopic": "notifications-topic", "enabled": true, "createdDate": 1625097600000, "lastUpdatedDate": 1625184000000 } ] } } } }, "403": { "description": "Forbidden - Not authorized to access this account's subscriptions", "content": { "application/json": { "example": { "error": "Forbidden", "messages": [ "Access Denied" ], "path": "/rest/v1/accounts/acct_12345/subscriptions" } } } }, "200": { "description": "Subscriptions updated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionWrapper" }, "example": { "subscriptions": [ { "subscriptionId": "123e4567-e89b-12d3-a456-426614174000", "eventName": "Atom.Status", "destinationType": "EMAIL", "logLevel": "ERROR", "accountId": "acct_12345", "destinationEmail": "user@example.com", "enabled": true, "createdDate": 1625097600000, "lastUpdatedDate": 1625184000000 }, { "subscriptionId": "223e4567-e89b-12d3-a456-426614174001", "eventName": "Atom.Status", "destinationType": "EVENT_STREAMS", "logLevel": "WARN", "accountId": "acct_12345", "eventStreamsEnvironment": "production", "eventStreamsTopic": "notifications-topic", "enabled": true, "createdDate": 1625097600000, "lastUpdatedDate": 1625184000000 } ] } } } }, "400": { "description": "Invalid request (missing or invalid request body)", "content": { "application/json": { "example": { "error": "Bad Request", "messages": [ "Must provide a valid event name", "Must provide a valid logLevel" ], "path": "/rest/v1/accounts/acct_12345/subscriptions" } } } }, "204": { "description": "No content - account has no subscriptions and none were provided" }, "401": { "description": "Unauthorized - Authentication is required" }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "errorId": "62ccbcf6-6795-4e56-8868-cf34a9a833a1", "error": "Internal server error", "messages": [ "Could not open JPA EntityManager for transaction" ], "path": "/rest/v1/accounts/acct_12345/subscriptions" } } } } }, "security": [ { "bearer-auth": [] } ] }, "post": { "tags": [ "Subscriptions" ], "summary": "Create subscriptions", "description": "Creates one or more subscriptions for the specified account", "operationId": "createSubscriptions", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "description": "The Boomi account ID associated with the subscriptions" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionWrapper" } } }, "required": true }, "responses": { "204": { "description": "Request was valid but no subscriptions were created (empty subscriptions list)" }, "403": { "description": "Forbidden - Not authorized to access this account's subscriptions", "content": { "application/json": { "example": { "error": "Forbidden", "messages": [ "Access Denied" ], "path": "/rest/v1/accounts/acct_12345/subscriptions" } } } }, "400": { "description": "Invalid request (missing or invalid request body)", "content": { "application/json": { "example": { "error": "Bad Request", "messages": [ "Must provide a valid event name", "Must provide a valid logLevel" ], "path": "/rest/v1/accounts/acct_12345/subscriptions" } } } }, "201": { "description": "Subscriptions successfully created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionWrapper" }, "example": { "subscriptions": [ { "subscriptionId": "123e4567-e89b-12d3-a456-426614174000", "eventName": "Atom.Status", "destinationType": "EMAIL", "logLevel": "ERROR", "accountId": "acct_12345", "destinationEmail": "user@example.com", "enabled": true, "createdDate": 1625097600000, "lastUpdatedDate": 1625184000000 }, { "subscriptionId": "223e4567-e89b-12d3-a456-426614174001", "eventName": "Atom.Status", "destinationType": "EVENT_STREAMS", "logLevel": "WARN", "accountId": "acct_12345", "eventStreamsEnvironment": "production", "eventStreamsTopic": "notifications-topic", "enabled": true, "createdDate": 1625097600000, "lastUpdatedDate": 1625184000000 } ] } } } }, "401": { "description": "Unauthorized - Authentication is required" }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "errorId": "62ccbcf6-6795-4e56-8868-cf34a9a833a1", "error": "Internal server error", "messages": [ "Could not open JPA EntityManager for transaction" ], "path": "/rest/v1/accounts/acct_12345/subscriptions" } } } } }, "security": [ { "bearer-auth": [] } ] }, "delete": { "tags": [ "Subscriptions" ], "summary": "Delete all subscriptions for an account", "description": "Deletes all subscriptions associated with the specified accountId", "operationId": "deleteSubscriptionForAccount", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "description": "The Boomi account ID associated with the subscriptions" } } ], "responses": { "204": { "description": "All subscriptions successfully deleted" }, "403": { "description": "Forbidden - Not authorized to access this account's subscriptions", "content": { "application/json": { "example": { "error": "Forbidden", "messages": [ "Access Denied" ], "path": "/rest/v1/accounts/acct_12345/subscriptions" } } } }, "404": { "description": "No subscriptions found for account", "content": { "application/json": { "example": { "error": "Entity not found", "messages": [ "No subscriptions found for account acct_12345" ], "path": "/rest/v1/accounts/acct_12345/subscriptions" } } } }, "401": { "description": "Unauthorized - Authentication is required" }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "errorId": "62ccbcf6-6795-4e56-8868-cf34a9a833a1", "error": "Internal server error", "messages": [ "Could not open JPA EntityManager for transaction" ], "path": "/rest/v1/accounts/acct_12345/subscriptions" } } } } }, "security": [ { "bearer-auth": [] } ] }, "patch": { "tags": [ "Subscriptions" ], "summary": "Bulk operations on subscriptions for an account", "description": "Performs bulk delete or bulk update operations on subscriptions for the specified account", "operationId": "bulkOperationsOnSubscriptionsForAccount", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "description": "The Boomi account ID associated with the subscriptions" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionPatchRequest" } } }, "required": true }, "responses": { "207": { "description": "Multi-status response with results of operations", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionPatchResponseWrapper" } } } }, "403": { "description": "Forbidden - Not authorized to access this account's subscriptions", "content": { "application/json": { "example": { "error": "Forbidden", "messages": [ "Access Denied" ], "path": "/rest/v1/accounts/acct_12345/subscriptions" } } } }, "400": { "description": "Invalid request (missing or invalid request body)", "content": { "application/json": { "example": { "error": "Bad Request", "messages": [ "Invalid operation. Supported operations are: delete, update" ], "path": "/rest/v1/accounts/acct_12345/subscriptions" } } } }, "401": { "description": "Unauthorized - Authentication is required" }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "errorId": "62ccbcf6-6795-4e56-8868-cf34a9a833a1", "error": "Internal server error", "messages": [ "Could not open JPA EntityManager for transaction" ], "path": "/rest/v1/accounts/acct_12345/subscriptions" } } } } }, "security": [ { "bearer-auth": [] } ] } }, "/rest/v1/accounts/{accountId}/subscriptions/{subscriptionId}": { "get": { "tags": [ "Subscriptions" ], "summary": "Get a single subscription by subscriptionId", "description": "Retrieves a single event subscription associated with the specified account by the subscriptionId", "operationId": "getSubscribedEventForAccount", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "description": "The Boomi account ID associated with the subscriptions" } }, { "name": "subscriptionId", "in": "path", "required": true, "description": "Unique identifier of the subscription to retrieve, update, or delete", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "404": { "description": "No subscription found for the account with supplied subscriptionId", "content": { "application/json": { "example": { "error": "Entity not found", "messages": [ "No subscription found for Id 123e4567-e89b-12d3-a456-426614174000" ], "path": "/rest/v1/accounts/boomi-internal/subscriptions/123e4567-e89b-12d3-a456-426614174000" } } } }, "403": { "description": "Forbidden - Not authorized to access this account's subscriptions", "content": { "application/json": { "example": { "error": "Forbidden", "messages": [ "Access Denied" ], "path": "/rest/v1/accounts/acct_12345/subscriptions" } } } }, "200": { "description": "Successfully retrieved subscription", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionWrapper" }, "example": { "subscriptionId": "223e4567-e89b-12d3-a456-426614174001", "eventName": "Atom.Status", "destinationType": "EVENT_STREAMS", "logLevel": "WARN", "accountId": "acct_12345", "eventStreamsEnvironment": "production", "eventStreamsTopic": "notifications-topic", "enabled": true, "createdDate": 1625097600000, "lastUpdatedDate": 1625184000000 } } } }, "401": { "description": "Unauthorized - Authentication is required" }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "errorId": "62ccbcf6-6795-4e56-8868-cf34a9a833a1", "error": "Internal server error", "messages": [ "Could not open JPA EntityManager for transaction" ], "path": "/rest/v1/accounts/acct_12345/subscriptions" } } } } }, "security": [ { "bearer-auth": [] } ] }, "put": { "tags": [ "Subscriptions" ], "summary": "Update a subscription", "description": "Updates an existing subscription for the specified account and subscriptionId", "operationId": "updateSubscription", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "description": "The Boomi account ID associated with the subscriptions" } }, { "name": "subscriptionId", "in": "path", "required": true, "description": "Unique identifier of the subscription to retrieve, update, or delete", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionWrapper" } } }, "required": true }, "responses": { "403": { "description": "Forbidden - Not authorized to access this account's subscriptions", "content": { "application/json": { "example": { "error": "Forbidden", "messages": [ "Access Denied" ], "path": "/rest/v1/accounts/acct_12345/subscriptions" } } } }, "400": { "description": "Invalid request (missing or invalid request body)", "content": { "application/json": { "example": { "error": "Bad Request", "messages": [ "Must provide a valid event name", "Must provide a valid logLevel" ], "path": "/rest/v1/accounts/acct_12345/subscriptions" } } } }, "200": { "description": "Subscription successfully updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionWrapper" }, "example": { "subscriptions": [ { "subscriptionId": "123e4567-e89b-12d3-a456-426614174000", "eventName": "Atom.Status", "destinationType": "EMAIL", "logLevel": "ERROR", "accountId": "acct_12345", "destinationEmail": "user@example.com", "enabled": true, "createdDate": 1625097600000, "lastUpdatedDate": 1625184000000 }, { "subscriptionId": "223e4567-e89b-12d3-a456-426614174001", "eventName": "Atom.Status", "destinationType": "EVENT_STREAMS", "logLevel": "WARN", "accountId": "acct_12345", "eventStreamsEnvironment": "production", "eventStreamsTopic": "notifications-topic", "enabled": true, "createdDate": 1625097600000, "lastUpdatedDate": 1625184000000 } ] } } } }, "401": { "description": "Unauthorized - Authentication is required" }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "errorId": "62ccbcf6-6795-4e56-8868-cf34a9a833a1", "error": "Internal server error", "messages": [ "Could not open JPA EntityManager for transaction" ], "path": "/rest/v1/accounts/acct_12345/subscriptions" } } } }, "404": { "description": "Subscription not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionWrapper" }, "example": { "error": "Entity not found", "messages": [ "No subscription found for Id 123e4567-e89b-12d3-a456-426614174000" ], "path": "/rest/v1/accounts/boomi-internal/subscriptions/123e4567-e89b-12d3-a456-426614174000" } } } } }, "security": [ { "bearer-auth": [] } ] }, "delete": { "tags": [ "Subscriptions" ], "summary": "Delete a specific subscription", "description": "Deletes a single subscription identified by subscriptionId for the specified account", "operationId": "deleteSubscription", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "description": "The Boomi account ID associated with the subscriptions" } }, { "name": "subscriptionId", "in": "path", "required": true, "description": "Unique identifier of the subscription to retrieve, update, or delete", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "403": { "description": "Forbidden - Not authorized to access this account's subscriptions", "content": { "application/json": { "example": { "error": "Forbidden", "messages": [ "Access Denied" ], "path": "/rest/v1/accounts/acct_12345/subscriptions" } } } }, "204": { "description": "Subscription successfully deleted" }, "404": { "description": "No subscriptions found for account", "content": { "application/json": { "example": { "error": "Entity not found", "messages": [ "No subscription found for Id 123e4567-e89b-12d3-a456-426614174000" ], "path": "/rest/v1/accounts/boomi-internal/subscriptions/123e4567-e89b-12d3-a456-426614174000" } } } }, "401": { "description": "Unauthorized - Authentication is required" }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "errorId": "62ccbcf6-6795-4e56-8868-cf34a9a833a1", "error": "Internal server error", "messages": [ "Could not open JPA EntityManager for transaction" ], "path": "/rest/v1/accounts/acct_12345/subscriptions" } } } } }, "security": [ { "bearer-auth": [] } ] } }, "/rest/v1/accounts/{accountId}/eventStreams/topic/subscription": { "post": { "tags": [ "ESTopicAndSubscription" ], "operationId": "createSubscriptions_1", "parameters": [ { "name": "accountId", "in": "path", "description": "The Boomi account ID associated with the subscriptions", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateEventStreamTopicAndSubscriptionDto" } } }, "required": true }, "responses": { "403": { "description": "Forbidden - Not authorized to access this account's subscriptions", "content": { "application/json": { "example": { "error": "Forbidden", "messages": [ "Access Denied" ], "path": "/rest/v1/accounts/acct_12345/subscriptions" } } } }, "401": { "description": "Unauthorized - Authentication is required" }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "errorId": "62ccbcf6-6795-4e56-8868-cf34a9a833a1", "error": "Internal server error", "messages": [ "Could not open JPA EntityManager for transaction" ], "path": "/rest/v1/accounts/acct_12345/subscriptions" } } } } } } }, "/rest/v1/log-levels": { "get": { "tags": [ "Log Levels" ], "summary": "Get all log levels", "description": "Returns a list of all available log levels with their names and descriptions", "operationId": "getLogLevels", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogLevelWrapper" } } } }, "403": { "description": "Forbidden - Not authorized to access this account's subscriptions", "content": { "application/json": { "example": { "error": "Forbidden", "messages": [ "Access Denied" ], "path": "/rest/v1/accounts/acct_12345/subscriptions" } } } }, "401": { "description": "Unauthorized - Authentication is required" }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "errorId": "62ccbcf6-6795-4e56-8868-cf34a9a833a1", "error": "Internal server error", "messages": [ "Could not open JPA EntityManager for transaction" ], "path": "/rest/v1/accounts/acct_12345/subscriptions" } } } } }, "security": [ { "bearer-auth": [] } ] } }, "/rest/v1/events": { "get": { "tags": [ "Events" ], "summary": "Get all events", "description": "Returns a list of all available events", "operationId": "listEvents", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventWrapper" } } } }, "403": { "description": "Forbidden - Not authorized to access this account's subscriptions", "content": { "application/json": { "example": { "error": "Forbidden", "messages": [ "Access Denied" ], "path": "/rest/v1/accounts/acct_12345/subscriptions" } } } }, "401": { "description": "Unauthorized - Authentication is required" }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "errorId": "62ccbcf6-6795-4e56-8868-cf34a9a833a1", "error": "Internal server error", "messages": [ "Could not open JPA EntityManager for transaction" ], "path": "/rest/v1/accounts/acct_12345/subscriptions" } } } } }, "security": [ { "bearer-auth": [] } ] } }, "/rest/v1/destination-types": { "get": { "tags": [ "Destination Types" ], "summary": "Get all destination types", "description": "Returns a list of all available destination types with their names and descriptions", "operationId": "getDestinationTypes", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DestinationTypeWrapper" } } } }, "403": { "description": "Forbidden - Not authorized to access this account's subscriptions", "content": { "application/json": { "example": { "error": "Forbidden", "messages": [ "Access Denied" ], "path": "/rest/v1/accounts/acct_12345/subscriptions" } } } }, "401": { "description": "Unauthorized - Authentication is required" }, "500": { "description": "Internal server error", "content": { "application/json": { "example": { "errorId": "62ccbcf6-6795-4e56-8868-cf34a9a833a1", "error": "Internal server error", "messages": [ "Could not open JPA EntityManager for transaction" ], "path": "/rest/v1/accounts/acct_12345/subscriptions" } } } } }, "security": [ { "bearer-auth": [] } ] } } }, "components": { "securitySchemes": { "bearer-auth": { "type": "http", "description": "JWT Bearer token authentication.", "scheme": "bearer", "bearerFormat": "JWT" } }, "schemas": { "PaginationMetadata": { "type": "object", "properties": { "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "totalElements": { "type": "integer", "format": "int64" }, "numberOfElements": { "type": "integer", "format": "int32" }, "first": { "type": "boolean" }, "last": { "type": "boolean" } } }, "Subscription": { "required": [ "destinationType", "eventName", "logLevel" ], "type": "object", "properties": { "subscriptionId": { "type": "string", "description": "Unique identifier for the subscription", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "eventName": { "type": "string", "description": "Name of the event to subscribe to", "example": "Atom.Status" }, "destinationType": { "type": "string", "description": "Type of destination where notifications will be sent", "example": "EMAIL", "enum": [ "EMAIL", "EVENT_STREAMS" ] }, "logLevel": { "type": "string", "description": "Minimum log level that will trigger notifications", "example": "ERROR", "enum": [ "INFO", "WARNING", "ERROR" ] }, "accountId": { "type": "string", "description": "Account identifier associated with this subscription", "example": "acct_12345" }, "destinationEmail": { "type": "string", "description": "Email address where notifications will be sent (when destinationType is EMAIL)", "example": "user@example.com" }, "eventStreamsEnvironment": { "type": "string", "description": "Event streams environment ID (when destinationType is EVENT_STREAMS)", "example": "0b8bc0ef-d4d1-4797-9234-935cf0ff3f63" }, "eventStreamsEnvironmentName": { "type": "string", "description": "Event streams environment name (when destinationType is EVENT_STREAMS)", "example": "production" }, "eventStreamsTopic": { "type": "string", "description": "Event streams topic (when destinationType is EVENT_STREAMS)", "example": "notifications-topic" }, "enabled": { "type": "boolean", "description": "Whether the subscription is currently active", "example": true, "default": true }, "createdDate": { "type": "integer", "description": "Timestamp when the subscription was created (Unix timestamp in milliseconds)", "format": "int64", "example": 1625097600000 }, "lastUpdatedDate": { "type": "integer", "description": "Timestamp when the subscription was last updated (Unix timestamp in milliseconds)", "format": "int64", "example": 1625184000000 }, "createdBy": { "type": "string", "description": "Email of the user who created the subscription", "example": "user@example.com" }, "lastUpdatedUserId": { "type": "string", "description": "Email of the user who last updated the subscription", "example": "user@example.com" } }, "description": "Represents a subscription to receive notifications for specific events" }, "SubscriptionWrapper": { "type": "object", "properties": { "subscriptions": { "type": "array", "description": "List of subscription configurations", "items": { "$ref": "#/components/schemas/Subscription" } }, "subscription": { "$ref": "#/components/schemas/Subscription" }, "paginationMetadata": { "$ref": "#/components/schemas/PaginationMetadata" } }, "description": "A wrapper that contains either a single subscription or a list of subscriptions" }, "CreateEventStreamTopicAndSubscriptionDto": { "required": [ "eventStreamsEnvironmentId", "eventStreamsSubscriptionName", "topicName" ], "type": "object", "properties": { "eventStreamsEnvironmentId": { "type": "string", "description": "Event streams environment ID", "example": "0b8bc0ef-d4d1-4797-9234-935cf0ff3f63" }, "eventStreamsSubscriptionName": { "type": "string", "description": "Event streams subscription name", "example": "Subscription1" }, "topicName": { "type": "string", "description": "Name of Event Streams Topic", "example": "Topic1" }, "topicDescription": { "type": "string", "description": "Description of Event Streams topic", "example": "Topic for User updates" } }, "description": "Create a new ES topic and ES subscription for a new event notification" }, "SubscriptionPatchRequest": { "required": [ "operation" ], "type": "object", "properties": { "subscriptionIds": { "type": "array", "description": "List of subscription IDs to perform the operation on (required for delete operation)", "items": { "type": "string", "description": "Unique identifier for a subscription", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" } }, "subscriptions": { "type": "array", "description": "List of subscription objects to update (required for update operation)", "items": { "$ref": "#/components/schemas/Subscription" } }, "operation": { "type": "string", "description": "Operation to perform on the specified subscriptions", "example": "DELETE", "enum": [ "DELETE", "UPDATE" ] } }, "description": "Request wrapper for batch operations on subscriptions", "example": { "subscriptionIds": [ "123e4567-e89b-12d3-a456-426614174000", "223e4567-e89b-12d3-a456-426614174001" ], "operation": "DELETE" } }, "SubscriptionPatchResponse": { "type": "object", "properties": { "subscriptionId": { "type": "string", "description": "Unique identifier of the subscription that was processed", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" }, "httpEquivalentCode": { "type": "integer", "description": "HTTP status code equivalent representing the result of the operation", "format": "int32", "example": 200 }, "message": { "type": "string", "description": "Descriptive message about the result of the operation", "example": "Subscription successfully deleted" } }, "description": "Response containing the result of a patch operation on a subscription", "example": { "subscriptionId": "123e4567-e89b-12d3-a456-426614174000", "httpEquivalentCode": 200, "message": "Updated successfully" } }, "SubscriptionPatchResponseWrapper": { "type": "object", "properties": { "operationStatuses": { "type": "array", "description": "List of responses for each subscription that was processed in the batch operation", "items": { "$ref": "#/components/schemas/SubscriptionPatchResponse" } } }, "description": "Wrapper containing the results of batch operations on multiple subscriptions", "example": { "operationStatuses": [ { "subscriptionId": "123e4567-e89b-12d3-a456-426614174000", "httpEquivalentCode": 200, "message": "Updated successfully" }, { "subscriptionId": "223e4567-e89b-12d3-a456-426614174001", "httpEquivalentCode": 404, "message": "Subscription not found" } ] } }, "LogLevelWrapper": { "type": "object", "properties": { "logLevels": { "type": "array", "description": "List of available log levels for event notifications", "items": { "type": "object", "additionalProperties": { "type": "object", "description": "A map containing log level properties where keys are property names and values are property values", "example": { "level": "INFO", "description": "Information" } }, "description": "A map containing log level properties where keys are property names and values are property values", "example": { "level": "INFO", "description": "Information" } } } }, "description": "A container for a collection of log levels", "example": { "logLevels": [ { "name": "ERROR", "description": "Error" }, { "level": "WARNING", "description": "Warning" }, { "level": "INFO", "description": "Information" } ] } }, "EventDto": { "required": [ "eventId", "eventName" ], "type": "object", "properties": { "eventId": { "type": "string", "description": "Unique identifier for the event", "format": "uuid", "example": "bc13c60c-2e1a-4849-886d-26268637de38" }, "eventName": { "type": "string", "description": "Human-readable name of the event", "example": "Atom.Status" } }, "description": "Represents an event that can trigger notifications" }, "EventWrapper": { "type": "object", "properties": { "events": { "type": "array", "description": "List of events that can trigger notifications", "items": { "$ref": "#/components/schemas/EventDto" } } }, "description": "A container for a collection of events", "example": { "events": [ { "eventId": "bc13c60c-2e1a-4849-886d-26268637de38", "eventName": "Atom.Status" }, { "eventId": "6e21f46b-765b-4472-9c9d-0c06a838fddc", "eventName": "Process.Execution" } ] } }, "DestinationTypeWrapper": { "type": "object", "properties": { "destinationTypes": { "type": "array", "description": "List of destination types available for event notifications", "items": { "type": "object", "additionalProperties": { "type": "object", "description": "A map of destination type properties where keys are property names and values are property values", "example": { "type": "EMAIL", "displayName": "Email" } }, "description": "A map of destination type properties where keys are property names and values are property values", "example": { "type": "EMAIL", "displayName": "Email" } } } }, "description": "Wrapper containing a list of destination types with their properties", "example": { "destinationTypes": [ { "type": "EMAIL", "displayName": "Email" }, { "type": "EVENT_STREAMS", "displayName": "Event Streams" } ] } } } } }