> For the complete documentation index, see [llms.txt](https://docs.pandium.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pandium.com/getting-started/integration-patterns/provider-api.md).

# Provider API (Reverse Webhook)

The provider API pattern, sometimes called a reverse webhook: Pandium hosts a service that implements a third-party platform's spec so the platform can call it synchronously, as with the BigCommerce T

A provider API flips the direction of a standard integration. Instead of your integration calling the platform, the platform publishes a spec and calls a service you stand up, synchronously, in the middle of its own flow. The service answers exactly the way the spec demands and delegates the real work to your API.

Some people call this a reverse webhook, an inline hook, or a synchronous webhook. The difference from a normal webhook is that the platform waits for your answer, and your answer changes what happens next.

BigCommerce's Tax Provider API is the clearest example. During checkout, BigCommerce calls the provider to estimate tax, then calls again to commit, adjust, or void the document as the order moves through its life. The shopper is waiting on every one of those calls.

<figure><img src="https://4017407078-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MfJn-9R_dn6dvcGNcdk%2Fuploads%2Fgit-blob-592f448c9e3332199c6a1456911ffca2ebc08ecc%2F03-provider-api.png?alt=media" alt="An end user waits while the partner platform calls an adapter service hosted on Pandium, which translates between the platform&#x27;s contract and your API"><figcaption></figcaption></figure>

## How it is different from a standard integration

Most Pandium integrations run as a job: a script that starts, does its work, and exits. A provider API needs something else, a long-running service that is available whenever the platform decides to call it, with caching and a sensible fallback for when an upstream system is slow to respond. Latency and uptime stop being operational details and become features of the integration itself.

On Pandium, this pattern is delivered as a hosted service rather than a scheduled run. It uses the same per-customer configuration and secrets as the rest of your integrations, so one service can serve every customer on the platform while each customer's credentials and settings stay separate. Because it needs a different runtime from a standard integration, provider API work is scoped with the Pandium team rather than built self-serve. [Contact us](mailto:support@pandium.com) if you are building against a provider spec.

Because the third party defines the contract, this usually is not a choice between patterns. The platform mandates it, and the work is building to spec rather than designing around it.

## Where this shows up

* **Tax providers on BigCommerce**, answering calls to estimate, commit, adjust, and void a sales tax document during checkout
* **Shipping rate, payment, and fraud providers** on any commerce platform that exposes a provider contract for them
* Any service returning a live figure a platform needs on the spot, where the platform initiates the call, not you

## When to use it

There is typically no "when to use it." A platform either requires this pattern for the integration you are building, or it does not. The upside is depth: once it is built, you are a first-class provider inside the platform's own checkout, order, and refund flows for every customer who enables you.

## Related reading

* [Cassettes](https://docs.pandium.com/getting-started/integration-patterns/cassettes.md), the other pattern a platform dictates rather than you choosing it
* [Webhooks](https://docs.pandium.com/getting-started/integration-patterns/webhooks.md), for the asynchronous version where the platform tells you something happened and does not wait


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.pandium.com/getting-started/integration-patterns/provider-api.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
