Skip to main content

Rest Endpoint

A REST endpoint holds the necessary data to connect to an external system through HTTP REST.

Configuration Fields​

Each endpoint requires specific configuration settings:

  • Base URL – The external system's base URL.
  • Test Path – The path used to test the connection.
  • Expected Response – The expected HTTP status code or message.
  • Authentication Type – The authentication method required.

Authentication Fields​

Depending on the selected authentication method, additional authentication fields must be filled in.

Endpoint Properties​

Endpoints support custom properties that can be referenced by any plugin. These properties can store metadata such as partner information or other integration-specific details.

Example: Storing partner information:

Endpoint config