asyncPassthrough

Create

Asynchronously pull data from an endpoint not currently supported by Merge.

post/knowledgebase/v1/async-passthrough

Request

  • Base URL: https://api.merge.dev/api
  • URL: https://api.merge.dev/api/knowledgebase/v1/async-passthrough
  • Auth: HTTP bearer

Headers

X-Account-Tokenstring required

Token identifying the end user.

Request body

method'GET' | 'OPTIONS' | 'HEAD' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' required
  • GET - GET
  • OPTIONS - OPTIONS
  • HEAD - HEAD
  • POST - POST
  • PUT - PUT
  • PATCH - PATCH
  • DELETE - DELETE
pathstring required

The path of the request in the third party's platform.

base_url_overridestring nullable

An optional override of the third party's base url for the request.

datastring nullable

The data with the request. You must include a request_format parameter matching the data's format

headersobject nullable

The headers to use for the request (Merge will handle the account's authorization headers). Content-Type header is required for passthrough. Choose content type corresponding to expected format of receiving server.

request_format'JSON' | 'XML' | 'MULTIPART'
  • JSON - JSON
  • XML - XML
  • MULTIPART - MULTIPART
normalize_responseboolean

Optional. If true, the response will always be an object of the form {"type": T, "value": ...} where T will be one of string, boolean, number, null, array, object.

Response

async_passthrough_receipt_idstring uuid required

Changes

No recorded changes to this operation across all 1 revision of this API.