Event Notifications REST API Reference - Events

Toggle Pane

• Events
  • getGet all events

API docs by Redocly

Download OpenAPI Specification: Download

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

Events

API for retrieving available events

Required Privileges:

Ensure you have the Event Notification Administrator role.

Get all events

Returns a list of all available events

Authorizations:

bearer-auth

Responses

Response Schema: application/json

	Array of objects (EventDto) List of events that can trigger notifications
Array eventId required string <uuid> Unique identifier for the event eventName required string Human-readable name of the event

US

https://api.boomi.com/event-notifications-config/rest/v1/events

GB

https://api.platform.gb.boomi.com/event-notifications-config/rest/v1/events

Response samples

• 200
• 403
• 500

Content type

application/json

{

• "events": [

  • {

    • "eventId": "bc13c60c-2e1a-4849-886d-26268637de38",
    • "eventName": "Atom.Status"

    },
  • {

    • "eventId": "6e21f46b-765b-4472-9c9d-0c06a838fddc",
    • "eventName": "Process.Execution"

    }

  ]

}