Send passthrough request

POST 
/passthrough

Send request directly to a provider

Request

Header Parameters

x-customer-id stringrequired
The customer ID that uniquely identifies the customer in your application
Example: my-customer-1
x-provider-name stringrequired
The provider name
Example: salesforce

application/json

Body

required

path stringrequired

The path to send the request to (do not pass the domain)

method stringrequired

Possible values: [GET, POST, PUT, PATCH, DELETE]

headers object
Headers to pass to downstream
property name* string
query object
Query parameters to pass to downstream
property name* string
body object

Body to pass to downstream (can be string or JSON object)

oneOf

String body

string

Responses

200

Passthrough response

application/json

Schema

Schema

url stringrequired

The full URL the request was went to

status numberrequired

Status code from the downstream

headers objectrequired
The response headers from the downstream
property name* string
body object
The body from the downstream
anyOf
MOD1
string
MOD2
number
MOD3
integer
MOD4
boolean
MOD5
Array [
]

Example (from schema)

{
  "url": "https://customcrm.com/api/cars",
  "status": 200,
  "headers": {},
  "body": "string"
}

Example

{
  "url": "https://api.hubapi.com/crm/v3/schemas",
  "status": 200,
  "headers": {
    "x-hubspot-ratelimit-remaining": 99
  },
  "body": {
    "results": [
      {
        "labels": {
          "singular": "Contract",
          "plural": "Contracts"
        },
        "requiredProperties": [
          "name",
          "description"
        ]
      }
    ]
  }
}

Loading...