POST /v1/forwarding/requests

Creates a ForwardingRequest object.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/x-www-form-urlencoded"

Request body fields

Name Type Required Description
url String Yes

The destination URL for the forwarded request. Must be supported by the config.

expand[] Array No

Specifies which fields in the response should be expanded.

metadata Object No

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

request Object No

The request body and headers to be sent to the destination endpoint.

request.body String No
request.headers[] Array No
request.headers[].name String Yes
request.headers[].value String Yes
payment_method String Yes

The PaymentMethod to insert into the forwarded request. Forwarding previously consumed PaymentMethods is allowed.

replacements[] Array Yes

The field kinds to be replaced in the forwarded request.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.