When should I use a passthrough request?

Use a passthrough request when our unified API doesn't cover what you need. We forward your request to the provider's API with the credentials we already hold for that connector, and return the provider's response unchanged.

Good reasons to use passthrough

• The data has no unified model yet, for example project data in Workday.

• You need an endpoint or action that only that provider offers.

• You need to write data that has no unified write endpoint.

• You need a one-off administrative call.

With passthrough you can go live with a customer now, instead of waiting for us to build a new unified model.

When to use something else

• The value is already in raw_data. Map it as a custom field and it comes back with the unified record.

• The write is supported natively. Check the unified write endpoints and their Meta APIs first.

What to expect

• Responses aren't normalized. The path, parameters, response shape and pagination are all the provider's own, so work from the provider's API documentation.

• Paths use the provider's IDs (remote_id), not Bindbee IDs.

• The request runs with the connector's credentials, so it can only do what the customer's integration user is allowed to do.