OpenBOM extends REST API to support events

Oleg Shilovitsky
Oleg Shilovitsky
23 February, 2023 | 2 min for reading
OpenBOM extends REST API to support events

At OpenBOM, we focus on how to support a rich set of customizations and data integrations using OpenBOM REST API available to all customers. One of the recent API features we announced is a release of an extended REST API that supports webhooks and events. This new API allows OpenBOM customers to get on the next level of integration of their product data with other systems and applications, such as enterprise resource planning (ERP), customer relationship management (CRM), and other product lifecycle management (PLM) systems.

What are REST API events?

REST API events are user-defined HTTP callbacks that allow developers to receive real-time notifications about events that occur within an application. OpenBOM’s new API supports webhooks for events happening in OpenBOM. The first event supported by OpenBOM is “save revision”, Such an event is used in both simple Save Revision and more complex Change management scenarios with approvals and workflows (in the future more events will be supported such as the creation, modification, or deletion of BOM items, the addition of comments or attachments to BOM items, and the creation or modification of BOMs themselves. This functionality allows OpenBOM customers to keep their other systems in sync with their BOM data, reducing the need for manual data entry and improving data accuracy and consistency across systems.

How does it work?

The new API also supports event-driven architecture, allowing developers to build event-driven applications that respond to changes in OpenBOM data. Developers can subscribe to specific events and define actions to be taken when those events occur. For example, an application could be configured to send an event each time Revision is created. This is one of the key events and it is supported.

To get started with the new API, OpenBOM customers will need to generate an API key in their OpenBOM account and then use that key to authenticate API requests. The API documentation provides detailed information about the available endpoints and how to use them, along with examples in several programming languages.

There are two functions to support the events:

  • List Event Subscriptions
  • Subscribe to the event or update your subscriptions

As you can see a single event is supported in the coming release. Later more events will be supported.

Conclusion:

Overall, the new extended REST API with webhooks and events support is a significant step forward for OpenBOM, providing greater flexibility and integration capabilities for its customers. By allowing BOM data to be seamlessly integrated with other systems, OpenBOM is helping its customers to streamline their workflows and improve their overall productivity.

REGISTER FOR FREE to check how OpenBOM can help you today.

Best, Oleg 

Related Posts

Also on OpenBOM

4 6
22 November, 2024

Manufacturers usually start to manage their Bill of Materials (BOM) in Excel, but as businesses grow and the complexity of...

22 November, 2024

I’d like to share the story of xLM Solutions, a PLM service provider that focuses on helping businesses adapt and...

21 November, 2024

Manufacturing faces mounting challenges as product complexity grows, demanding advanced design and production capabilities to stay competitive. Cost pressures and...

20 November, 2024

In this article, we explore the story of Xtend AI, a company developing mobile intelligence and robotic platforms. With a...

16 November, 2024

OpenBOM’s open architecture empowers you to connect seamlessly with a variety of applications and services, enabling efficient collaboration across design...

15 November, 2024

With tariffs on Chinese imports potentially climbing above 60% and increases of 10% or more on goods from other regions,...

14 November, 2024

I’m thrilled to invite you to watch the second Design Projects Live Demo we held yesterday and check out more...

13 November, 2024

Product development success relies on the synergy between multiple team members. It is a teamwork. Engineers, project managers, procurement teams,...

12 November, 2024

I’m excited to share the great story of the Purdue Electric Racing Team and their journey to streamline CAD data...

To the top