Skip to main content

HTTP

Overview​

The HTTP Event Action allows ANSVIS to send AI task event data to an external system via an HTTP POST request. This action is configured per AI task and is triggered automatically when the AI task generates an event (e.g., detection, counting, recognition, etc.).

Typical integrations:
  • Send event result to CMS / MES
  • Notify central monitoring server
  • Push AI metadata to analytics platform
  • Integrate with third-party automation

Target Server​

URL: The endpoint that will receive the event data.

https://yourserver.com/api/event/receive

Method: All event data is sent in the POST request body.

POST

Media Options (optional)​

ANSVIS can attach event-related media to the HTTP request.

Append Video​

To use this feature, Cloud storage must be configured in system settings.

  • A short video clip is generated from camera frames around the event time.
  • The video is uploaded to the configured cloud storage.
  • The HTTP request includes a URL pointing to the uploaded video.
  • The Video Configurations dialog allows users to configure video display setting

Append Image​

Image Size selection:

  • Cloud Image Storage: Image is uploaded to cloud storage and the POST request includes the image URL.
  • Base64 format: Image is converted to Base64 format with selected resolution and Base64 image is included directly in the POST body.

Add Object Overlays to Images If enabled, the bounding boxes and detection labels are drawn on the image before sending. User can disable it if they want to handle the overlay from the external system using the event data.

Payload Format (Style)​

The Style option defines the structure of the HTTP POST body.

Available styles include:
  • Standard
  • Standard-Verbose
  • Custom Event Data
  • Serialized Custom Format
  • PLC Server
  • Fully Custom
  • Fully Serialized Custom

Standard Style​

Uses the predefined ANSVIS event data structure.

You can refer to the Example Post Data on the right-side panel for standard style data (JSON structure). Each rule type and pipeline option will have different example.

Fully Custom Style​

Allows users to define a custom JSON structure.

Users can use the Configure Custom Format dialog to design the request body, including:

  • Insert predefined tags
  • Rename fields
  • Control data hierarchy
  • Match external system format requirements
  • Dynamic tags (e.g., camera ID, event name, confidence score) are automatically replaced with actual values when the event occurs.

Authentication (Optional)​

If the external API requires authentication, enable Login Required.

ANSVIS will:

  • Send a login request to the configured Login URL.
  • Use the provided Login POST Data.
  • Extract the token from the login response.
  • Attach the token to the HTTP event request.

Login URL: The authentication endpoint of the external system.

https://yourserver.com/api/login

Login POST Data: JSON data required by the authentication API.

{
  "username": "your_user",
  "password": "your_password"
}

Token Type Name: Defines how the token is attached in the Authorization header.

Bearer //Example

Token Name: The field name in the login response containing the token.

accessToken //Example

Skip Trigger When Cloud Image Upload Failed​

This option controls whether the HTTP event is sent using an Asynchronous (Async) or Synchronous (Sync) execution model when cloud media upload is enabled.

Disabled (Default)​

Use this mode when real-time event delivery is more important than guaranteed media availability.

  • Execution Model: Asynchronous Mode (Async)
  • HTTP event is sent immediately after the AI event occurs.
  • Media upload runs in parallel.
  • Even if media upload fails, the HTTP request is still sent.

Enabled​

Use this mode when the external system requires a valid and accessible media link for every event.

  • Execution Model: Synchronous Mode (Sync)
  • ANSVIS waits for media upload to complete.
  • HTTP event is sent only after successful upload.
  • If upload fails, the event is not sent.
Important Notes
  • Synchronous (Sync) mode may increase event latency.
  • This setting applies only when using cloud media upload (image/video).
  • Does not affect Base64 image mode.

Send Test Trigger​

After finishing HTTP configuration, you can use the Send Test Trigger button to sends sample event data to the configured URL

This will helps verify: Connectivity, Authentication, Payload compatibility

Debug Mode​

If enabled:

  • Logs HTTP request details.
  • Logs server response.
  • Useful for integration troubleshooting.
caution

Should be disabled in production environments.