Integration Methods

Welcome to the integration guide for the Incident Detection API. This API offers two distinct consumption methods designed to suit various operational needs and preferences, allowing you to seamlessly incorporate incident information into your systems.

Overview of Integration Methods

The Incident Detection API provides flexible integration options through its two primary consumption modes:

Pull Method

The Pull Method allows users to access incident information on-demand by sending API requests to a dedicated Incidents API endpoint. This method is ideal for systems that require data retrieval in alignment with their specific data consumption lifecycle. By utilizing this approach, you can retrieve up-to-date incident details whenever necessary, ensuring that your system remains synchronized with the latest information.

Push Method

The Push Method offers a proactive data delivery approach. In this mode, the Incident Detection Service actively initiates API calls to your system, delivering incident information as soon as it is created within our system. This method is perfect for applications that need immediate updates and want to minimize the need for frequent data polling.

Benefits of Each Integration Method

• Pull Method:

  • Customizable Data Retrieval: Retrieve incident information based on your system’s specific needs and timing.

  • Efficient Data Handling: Manage and process data retrieval according to your operational schedule.

• Push Method:

  • Real-Time Updates: Receive incident information as soon as it becomes available, enhancing your system’s responsiveness.

  • Reduced Latency: Minimize delays by eliminating the need for frequent data requests.