Event Notifications

Overview

The Production Hub & OMS (Order Management System) offers robust event notification capabilities to keep your systems up-to-date with important changes and milestones in the order fulfillment process. By leveraging these notifications, you can create more responsive and efficient workflows, reducing the need for frequent API polling and ensuring that your systems are always in sync with the latest updates.

One of the key events we support is the "Print File Ready" notification, which alerts you when a print file for a specific order item is prepared and ready for further processing or printing.

Notification Methods

We offer three methods for receiving event notifications:

  1. HTTPS Webhooks
  2. Third-party API Integration (Enterprise clients)
  3. Cloud-based Event Bus (Enterprise clients)

1. HTTPS Webhooks

Webhooks allow you to receive real-time notifications about specific events in your Production Hub & OMS account. After subscribing to a webhook topic, your application can execute code immediately after specific events occur, such as when a print file becomes ready.

By using webhooks, you can:

  • Receive immediate updates about important events
  • Reduce the number of API calls needed to check the status of orders and print files
  • Create more responsive and efficient applications
  • Automate workflows based on specific events

For example, you can use webhooks to trigger actions in your application when a print file is ready, when an order status changes, or when a new order is received. This ensures that your systems are always up-to-date with the latest information from the Production Hub & OMS.


Webhook Retry Policy

To ensure reliable delivery of webhook notifications, we implement the following retry policy:

  • If the initial webhook request doesn't receive a 200 success response, we will retry the notification up to 3 times within a 24-hour period.
  • Retries are spaced out to allow for temporary issues to be resolved.
  • After 3 failed attempts or 24 hours (whichever comes first), the webhook notification will be marked as failed, and no further attempts will be made.

It's important to ensure that your webhook endpoint is able to handle incoming requests reliably and respond with a 200 status code for successfully processed notifications.

2. Third-party API Integration (Enterprise Clients)

For enterprise clients with specific integration needs, we offer the option to integrate with your existing third-party APIs. This method allows for seamless incorporation of Production Hub & OMS events into your current systems and workflows.

Key benefits of third-party API integration include:

  • Custom data formats and structures to match your existing systems
  • Integration with your current authentication and security measures
  • Flexibility to handle events in a way that best suits your business processes

If you're interested in this option, please contact us to discuss your specific requirements and set up the integration.

3. Cloud-based Event Bus (Enterprise Clients)

For enterprise clients requiring high-scalability and advanced event processing capabilities, we offer integration with cloud-based event bus services. This option is ideal for clients who need to process large volumes of events or require complex event routing and filtering.

Advantages of using a cloud-based event bus include:

  • High throughput and low latency for real-time event processing
  • Advanced filtering and routing capabilities
  • Scalability to handle varying event volumes
  • Integration with other cloud services and data processing pipelines

If you're interested in leveraging a cloud-based event bus for event notifications, please reach out to us to discuss available options and setup procedures.

Getting Started with Webhooks

Currently, webhook setup is managed manually by our team to ensure proper configuration and security. To start receiving webhook notifications:

  1. Contact us and express your interest in setting up webhook notifications.
  2. Provide the following information:
    • The URL of your webhook endpoint
    • The specific events you want to subscribe to (e.g., "Print File Ready")
    • Any additional requirements or preferences for the webhook setup
  3. Our team will configure the webhook on our end and provide you with any necessary authentication tokens or keys.
  4. We'll work with you to test the webhook to ensure it's functioning correctly.

Please note that while we manage the webhook setup, you are responsible for maintaining the endpoint that will receive the notifications. Make sure your endpoint is prepared to handle incoming POST requests and can respond with a 200 status code for successfully processed notifications.

If you need to make any changes to your webhook configuration or have any questions about the setup process, please contact us.

Conclusion

By leveraging event notifications, you can create more responsive, efficient, and automated workflows that stay in sync with the latest updates from the Production Hub & OMS. Whether you choose webhooks, third-party API integration, or a cloud-based event bus, these notification methods will help you build more robust and real-time applications.

If you have any questions or need assistance setting up event notifications, please don't hesitate to contact us.