Event Notifications REST APIs Overview

The Event Notifications REST API enables you to configure and manage event notification subscriptions for an account, including creating, updating, retrieving, and deleting subscriptions programmatically.

note

EMAIL destination type is not supported in the current release. Only EVENT_STREAMS is available.

Authentication

All Event Notifications REST API endpoints require JWT bearer token authentication. Include your authentication token in the Authorization header of each request:

Authorization: Bearer <your-jwt-token>

Important

JWT tokens expire after 5 minutes. If you make a request with an expired token, you will receive a 401 error.

For detailed information on authentication, refer to JWT authentication tokens.

Required Privileges

Ensure you have the Event Notification Administrator role.

Base URL

The following base URLs are available based on your account's region:

• US: https://api.boomi.com/event-notifications-config

• GB: https://api.platform.gb.boomi.com/event-notifications-config

Request and Response format

All API requests and responses use JSON format. Include the following header:

Content-Type: application/json

Error codes

For information about HTTP status codes and error responses, refer to Boomi Platform REST API errors.

Interactive API Testing

Import the Boomi Event Notifications API collection into Postman to test endpoints, view request examples, and accelerate your integration development.

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