Classic file types are no longer available for use as of January 2021. You can transition your classic files or download a PDF. Learn More

HTTP Request connector

  • Last updated on

With the HTTP Request connector, you can use commands in a chain to perform hypertext transfer protocol (HTTP) GET, POST, PUT, and DELETE requests to a given URL. For example, you can use this connector in a chain to connect and automate other solutions through their respective connectors.

To see how an HTTP Request is structured, see our HTTP Connector example list.

Requirements

  • While the connection has no OData-specific features, you can add any necessary components of the request via the Headers or Query string parameters.
  • To make the connector available for use in your organization's chains, an org security administrator must first enable it.

Set up the HTTP Request connector

  1. From Chain Builder, click Connections  compare_arrows, and then Create at the top right.
  2. Under BizApp Connection, select HTTP Request and the default CloudRunner.
    http-request-connector_01.png
  3. Under Basic Info, enter a unique name and description to help identify the connector.
  4. Select the environments to use the connection, and click Save.
  5. To test the connection, create and run a chain with the connector's GET command, and verify it returns a valid output. 

Manage credentials for secure HTTP requests

To secure the connector's HTTP requests, you can set up its commands with:

  • Basic username and password authentication
  • Privacy-Enhanced Mail (PEM)-encoded certificates, such as for mutual Transport Layer Security (mTLS) authentication
    Note: Workiva does not generate certificates for HTTP requests. To use PEM-encoded certificates, provide the public/private key pair to send with requests and an optional Certificate Authority (CA) certificate.

To set up a command with credentials:

  1. In Chain Builder, upload the certificates as workspace resources.
  2. When you set up the connector's command, select the certificates as properties:
    http-mtls-properties.png
    • For basic authentication, enter or select the credentials in User name and Password.
    • For the public/private key pair, select their resources in Certificate and Certificate private key, respectively.
    • For an optional CA certificate, select its resource in CA certificate.

Troubleshooting

  • If an error is returned, review your source URL and the structure of your request. Our HTTP connector examples article details each required component.
  • Check that your query string is encoded.
Was this article helpful?
1 out of 3 found this helpful
With the HTTP Request connector, you can use commands in a chain to perform hypertext transfer protocol (HTTP) GET, P...