Header

Introduction

Any parameters added to the header tab are passed in the endpoint request headers. You can define default header parameters and optional header parameters:

Notice that the header tab is split into upper and lower panels:

• Required parameters
• Header filters

When an authentication method is applied to an endpoint, any header and body parameters specified for the authentication method are also sent in the endpoint requests - you don't need to add them twice.

Please refer to your API documentation for guidance on what values need to be passed in authentication headers.

Required parameters

If you have parameters that must always be passed in the endpoint request header, add them to the required parameters panel. Default options are added as key pairs, and are passed straight into request headers - users are never asked to provide values for these.

Header filters

If you have parameters that you want to expose to users in process flows and then pass provided values into the endpoint request header, add them to the lower panel.

Optional parameters are available for your users to update with their own required values, in process flows. These work the same way as noted for optional URL parameters, except any values provided by users (via the connection shape in process flows) are passed into the request headers, rather than being added as URL queries.

Disable automatic headers

Sometimes, depending on the endpoint configuration, Patchworks adds request headers automatically. This can be for different reasons - perhaps there's a specific requirement for an authentication method, or a content-type for a request body setting.

When the disable automatic headers option is toggled on, automatic headers are NOT sent when requests are made.

This option applies to ALL automatic headers. If you set this option, please check the outcome of subsequent requests carefully to ensure that behaviour is as expected.

Webhooks

If you are building a connector for a webhook, you must include a content-type header.

More information

Techniques for adding header parameters are the same as all other types of parameters that you may encounter in the connector builder. For information about these options please see the Working with parameters page.