Skip to Content

HTTP v2 Connector

Summary

The Harmony HTTP v2 Connector establishes access over the HTTP or HTTPS protocol to a service such as a REST API, GraphQL API, or web form.

The HTTP v2 connector provides an interface for creating an HTTP v2 connection, the foundation used for generating instances of HTTP v2 activities. These activities, once configured, interact with a service accessible over the HTTP or HTTPS protocol through the connection.

The HTTP v2 connector is accessed from the design component palette's Connections tab (see Design Component Palette).

For other ways to connect to a RESTful web service and a comparison with the HTTP connector, see REST-based Connector Considerations.

Important

With the release of the HTTP v2 connector, we recommend converting existing HTTP connections and activities to HTTP v2. Learn more about the benefits of the HTTP v2 connector in our HTTP v2 blog post or see a comparison of HTTP and HTTP v2 connector features.

Jitterbit's long-term intention is to deprecate the HTTP connector, which will be announced in accordance with Jitterbit's End-of-Life Policy. At present, there is no timeline for deprecation and the HTTP connector remains fully supported. We recommend that you convert existing HTTP connections and activities to HTTP v2 when possible.

Connector Overview

This connector is used to first configure an HTTP v2 connection. Activity types associated with that connection are then used to create instances of activities that can be used as sources (to provide data in an operation) or targets (to consume data in an operation).

Whether an activity instance can be used as a source or a target depends on whether the web service requires a structured request or returns a structured response. Each activity instance can be configured with request and response schemas using either user-provided custom schemas or default schemas included with the connector.

Together, a specific HTTP v2 connection and its activities are referred to as an HTTP v2 endpoint:

HTTP v2 activity types

  • PATCH: Applies partial modifications to an existing resource on a service accessible over the HTTP or HTTPS protocol and can be used as a source or target in an operation.

  • HEAD: Retrieves the status line and header section of a resource on a service accessible over the HTTP or HTTPS protocol and can be used as a source or target in an operation.

  • POST: Creates a new resource on a service accessible over the HTTP or HTTPS protocol and can be used as a source or target in an operation.

  • GET: Retrieves information about a resource on a service accessible over the HTTP or HTTPS protocol and can be used as a source or target in an operation.

  • OPTIONS: Retrieves information about the communication options for a resource on a service accessible over the HTTP or HTTPS protocol and can be used as a source or target in an operation.

  • DELETE: Deletes a resource on a service accessible over the HTTP or HTTPS protocol and can be used as a source or target in an operation.

  • PUT: Replaces an existing resource on a service accessible over the HTTP or HTTPS protocol and can be used as a source or target in an operation.

Note

This connector is a Connector SDK-based connector, which may be referred to by Jitterbit when communicating changes made to connectors built with the Connector SDK.

Prerequisites and Supported API Versions

The HTTP v2 connector requires the use of an agent version 10.1 or later. These agent versions automatically download the latest version of the connector when required.

The HTTP v2 connector is used to interact with a service accessible over the HTTP or HTTPS protocol using a user-specified REST API, GraphQL API, or web form. The HTTP v2 connector's request and response schemas are defined from either user-provided custom schemas or default schemas included with the connector.

Troubleshooting

If you experience issues with the HTTP v2 connector, these troubleshooting steps are recommended:

  1. Click the Test button in the connection configuration to ensure the connection is successful and to ensure the latest version of the connector is downloaded to the agent (unless using the Disable Auto Connector Update organization policy).

  2. Check the operation logs for any information written during execution of the operation.

  3. Enable operation debug logging (for Cloud Agents or for Private Agents) to generate additional log files and data.

  4. If using Private Agents, you can enable connector verbose logging for this connector using this specific configuration entry of logger name and level:

    <logger name="org.jitterbit.connector.verbose.logging.http" level="DEBUG"/>
    
  5. If using Private Agents, you can check the agent logs for more information.