Waiting for engine...
Skip to main content

Event Notifications REST API Reference - Subscriptions

Toggle Pane
API docs by Redocly

Download OpenAPI Specification: Download

Run In Postman

For more information about Postman collections, forking, and making your first API call, refer to the Working with Boomi APIs on Postman page.

Subscriptions

API for operating on an accounts subscriptions

Required Privileges:

Ensure you have the Event Notification Administrator role.

List all subscriptions for an account

Retrieves all event subscriptions associated with the specified account

Authorizations:
bearer-auth
path Parameters
accountId
required
string

The unique identifier of the Boomi account whose subscriptions are being managed

query Parameters
pageNumber
integer <int32>

Page number for pagination

pageSize
integer <int32>
Example: pageSize=20

Number of items per page

sortBy
string
Example: sortBy=createdDate

Field to sort by

sortDirection
string
Example: sortDirection=DESC

Sort direction (ASC or DESC)

Responses

Response Schema: application/json
Array of objects (Subscription)
object (Subscription)

A single subscription configuration

object (PaginationMetadata)

Response samples

Content type
application/json
{
  • "subscriptions": [
    • {
      },
    • {
      }
    ]
}

Update subscriptions for an account

Updates all subscriptions for the specified account. Creates subscriptions if none exist.

Authorizations:
bearer-auth
path Parameters
accountId
required
string

The unique identifier of the Boomi account whose subscriptions are being managed

Request Body schema: application/json
required
Array of objects (SubscriptionCreate)
Array
destinationType
required
string
Enum: "EMAIL" "EVENT_STREAMS"

Type of destination where notifications will be sent. Note: Only EVENT_STREAMS is currently supported.

eventName
required
string

Name of the event to subscribe to

logLevel
required
string
Enum: "INFO" "WARNING" "ERROR"

Minimum log level that will trigger notifications

eventStreamsEnvironment
string

Event streams environment ID (when destinationType is EVENT_STREAMS)

eventStreamsEnvironmentName
string

Event streams environment name (when destinationType is EVENT_STREAMS)

eventStreamsTopic
string

Event streams topic (when destinationType is EVENT_STREAMS)

enabled
boolean
Default: "true"

Whether the subscription is currently active

Responses

Response Schema: application/json
Array of objects (Subscription)
object (Subscription)

A single subscription configuration

object (PaginationMetadata)

Request samples

Content type
application/json
{
  • "subscriptions": [
    • {
      }
    ]
}

Response samples

Content type
application/json
{
  • "subscriptions": [
    • {
      },
    • {
      }
    ]
}

Create subscriptions

Creates one or more subscriptions for the specified account

Authorizations:
bearer-auth
path Parameters
accountId
required
string

The unique identifier of the Boomi account whose subscriptions are being managed

Request Body schema: application/json
required
Array of objects (SubscriptionCreate)
Array
destinationType
required
string
Enum: "EMAIL" "EVENT_STREAMS"

Type of destination where notifications will be sent. Note: Only EVENT_STREAMS is currently supported.

eventName
required
string

Name of the event to subscribe to

logLevel
required
string
Enum: "INFO" "WARNING" "ERROR"

Minimum log level that will trigger notifications

eventStreamsEnvironment
string

Event streams environment ID (when destinationType is EVENT_STREAMS)

eventStreamsEnvironmentName
string

Event streams environment name (when destinationType is EVENT_STREAMS)

eventStreamsTopic
string

Event streams topic (when destinationType is EVENT_STREAMS)

enabled
boolean
Default: "true"

Whether the subscription is currently active

Responses

Request samples

Content type
application/json
{
  • "subscriptions": [
    • {
      }
    ]
}

Response samples

Content type
application/json
{
  • "subscriptions": [
    • {
      },
    • {
      }
    ]
}

Delete all subscriptions for an account

Deletes all subscriptions associated with the specified accountId

Authorizations:
bearer-auth
path Parameters
accountId
required
string

The unique identifier of the Boomi account whose subscriptions are being managed

Responses

Response samples

Content type
application/json
{
  • "error": "Forbidden",
  • "messages": [
    • "Access Denied"
    ],
  • "path": "/rest/v1/accounts/acct_12345/subscriptions"
}

Bulk operations on subscriptions for an account

Performs bulk delete or bulk update operations on subscriptions for the specified account

Authorizations:
bearer-auth
path Parameters
accountId
required
string

The unique identifier of the Boomi account whose subscriptions are being managed

Request Body schema: application/json
required
operation
required
string
Enum: "delete" "update"

Operation to perform on the specified subscriptions

subscriptionIds
Array of any
Array of objects (Subscription)

Responses

Request samples

Content type
application/json
{
  • "subscriptionIds": [
    • "123e4567-e89b-12d3-a456-426614174000",
    • "223e4567-e89b-12d3-a456-426614174001"
    ],
  • "operation": "delete"
}

Response samples

Content type
application/json
Example

bulkDelete

{
  • "operationStatuses": [
    • {
      },
    • {
      },
    • {
      }
    ]
}

Get a single subscription by subscriptionId

Retrieves a single event subscription associated with the specified account by the subscriptionId

Authorizations:
bearer-auth
path Parameters
accountId
required
string

The unique identifier of the Boomi account whose subscriptions are being managed

subscriptionId
required
string <uuid>

The unique identifier of the subscription

Responses

Response Schema: application/json
Array of objects (Subscription)
object (Subscription)

A single subscription configuration

object (PaginationMetadata)

Response samples

Content type
application/json
{
  • "subscriptionId": "223e4567-e89b-12d3-a456-426614174001",
  • "eventName": "Atom.Status",
  • "destinationType": "EVENT_STREAMS",
  • "logLevel": "WARNING",
  • "accountId": "acct_12345",
  • "eventStreamsEnvironment": "0b8bc0ef-d4d1-4797-9234-935cf0ff3f63",
  • "eventStreamsEnvironmentName": "production",
  • "eventStreamsTopic": "notifications-topic",
  • "enabled": true,
  • "createdDate": 1625097600000,
  • "lastUpdatedDate": 1625184000000,
  • "createdBy": "user@example.com",
  • "lastUpdatedUserId": "user@example.com"
}

Update a subscription

Updates an existing subscription for the specified account and subscriptionId

Authorizations:
bearer-auth
path Parameters
accountId
required
string

The unique identifier of the Boomi account whose subscriptions are being managed

subscriptionId
required
string <uuid>

The unique identifier of the subscription

Request Body schema: application/json
required
required
object (SubscriptionCreate)

The subscription configuration to apply

destinationType
required
string
Enum: "EMAIL" "EVENT_STREAMS"

Type of destination where notifications will be sent. Note: Only EVENT_STREAMS is currently supported.

eventName
required
string

Name of the event to subscribe to

logLevel
required
string
Enum: "INFO" "WARNING" "ERROR"

Minimum log level that will trigger notifications

eventStreamsEnvironment
string

Event streams environment ID (when destinationType is EVENT_STREAMS)

eventStreamsEnvironmentName
string

Event streams environment name (when destinationType is EVENT_STREAMS)

eventStreamsTopic
string

Event streams topic (when destinationType is EVENT_STREAMS)

enabled
boolean
Default: "true"

Whether the subscription is currently active

Responses

Response Schema: application/json
Array of objects (Subscription)
object (Subscription)

A single subscription configuration

object (PaginationMetadata)

Request samples

Content type
application/json
{
  • "subscription": {
    • "eventName": "Atom.Status",
    • "destinationType": "EVENT_STREAMS",
    • "logLevel": "ERROR",
    • "eventStreamsEnvironment": "0b8bc0ef-d4d1-4797-9234-935cf0ff3f63",
    • "eventStreamsEnvironmentName": "production",
    • "eventStreamsTopic": "notifications-topic",
    • "enabled": true
    }
}

Response samples

Content type
application/json
{
  • "subscriptionId": "223e4567-e89b-12d3-a456-426614174001",
  • "eventName": "Atom.Status",
  • "destinationType": "EVENT_STREAMS",
  • "logLevel": "WARNING",
  • "accountId": "acct_12345",
  • "eventStreamsEnvironment": "0b8bc0ef-d4d1-4797-9234-935cf0ff3f63",
  • "eventStreamsEnvironmentName": "production",
  • "eventStreamsTopic": "notifications-topic",
  • "enabled": true,
  • "createdDate": 1625097600000,
  • "lastUpdatedDate": 1625184000000,
  • "createdBy": "user@example.com",
  • "lastUpdatedUserId": "user@example.com"
}

Delete a specific subscription

Deletes a single subscription identified by subscriptionId for the specified account

Authorizations:
bearer-auth
path Parameters
accountId
required
string

The unique identifier of the Boomi account whose subscriptions are being managed

subscriptionId
required
string <uuid>

The unique identifier of the subscription

Responses

Response samples

Content type
application/json
{
  • "error": "Forbidden",
  • "messages": [
    • "Access Denied"
    ],
  • "path": "/rest/v1/accounts/acct_12345/subscriptions/223e4567-e89b-12d3-a456-426614174001"
}