Skip to main content

General

Export to HTTP API

Flexible HTTP export with authentication, JSON payload, and configurable endpoints.

Flexible export to HTTP REST APIs with support for multiple authentication methods and JSON payloads. Ideal for integrating with web services, custom endpoints, and third-party APIs.

open_in_new

REST API Best Practices

Learn about RESTful design principles

Configuration Parameters

ParameterRequiredTypeDefaultDescription
UriYesstring-Target HTTP endpoint URL for data submission.
AuthenticationTypeNostring(none)Authentication type: Basic, Token, APIKey, or none.
UsernameNostring(empty)Username for Basic authentication.
PasswordNostring(empty)Password for Basic authentication.
TokenNostring(empty)Bearer token for token-based authentication.
APIKeyNostring(empty)API key for API key authentication.

Internal Behavior

HTTP Communication

  • POST Method: Each payload is sent via HTTP POST with application/json
  • JSON Serialization: Payloads are serialized using Proxus JSON context
  • Error Handling: Non-2xx responses raise an integration error

Performance Features

  • Authentication: Supports Basic, Token (Bearer), and APIKey headers.