Skip to main content

REST Endpoints

This integration is available as a feature of the Workflow Engine v1.2 and later.

You can use the REST Endpoints integration to configure multiple Kafka endpoints (known as brokers) for use with the Workflow Engine. After you set up an endpoint, you can use the exportViaRest function to send it data.

Before You Begin

Before you start to set up your integration, ensure you know the following values for your endpoint:

  • Endpoint Name: a unique name for the endpoint for use in Workflow Engine configuration

  • URL: destination for the endpoint. You can use substitutions in the URL for the current in-scope object in the workflow engine. For example to use the alert ID:$alert_id

  • Method: for the HTTP request. For example, POST

  • Timeout: value in seconds

  • You have identified any additional information required to access your endpoint:

    • Headers: additional HTTP headers. For example, Content-Type, or an API token. The default Content-Type is application/json

    • Security information: for example, basic authentication credentials

    • Proxy Settings: configuration required to access the endpoint within your environment

See REST Endpoints Reference for more information.

Configure the REST Endpoints Integration

To configure the REST Endpoints integration:

Navigate to the Integrations tab.

  1. Navigate to the Integrations tab.

  2. Click REST Endpoints in the Reporting and Dashboards section.

  3. Provide a unique integration name. You can use the default name or customize the name according to your needs.

  4. Enter the connection details for each endpoint you want to configure.

Use an Endpoint in a Workflow

After you complete the configuration, you can refer to the endpoint by name in your workflows. See exportViaRest for more information.