# Configure a Pipes provider

<div class="api-op" data-api-operation>
<div class="api-op__main">

<p class="api-endpoint"><span class="method method-put">PUT</span> <code>/v1/pipes/providers/&#123;provider&#125;</code></p>

Pipes product. Stores your OAuth client for a provider under the slug `provider` (the client secret sealed with the KMS envelope; never returned). Built-in kinds (github, google, slack, salesforce, hubspot, linear, notion) use the provider's published endpoints; kind oauth2 takes https authorize_url and token_url (and optional revoke_url). Register `https://api.<your domain>/pipes/callback` as the redirect URI at the provider. At most 100 providers per environment. While any connection of the provider is connected, its authorize, token and revoke endpoint hosts (and so its kind) can't change, and the request answers pipe_provider_has_connections.

<dl class="api-facts"><div><dt>Scope</dt><dd><code>pipes:write</code></dd></div><div><dt>Auth</dt><dd>Secret key (<code>sk_…</code>)</dd></div><div><dt>Since</dt><dd>1.1</dd></div></dl>

## Path parameters

<ul class="api-fields">
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">provider</code> <span class="api-field__type">string</span> <span class="api-field__required">Required</span></p>
</li>
</ul>

## Headers

<ul class="api-fields">
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">OhAuthCat-Version</code> <span class="api-field__type">string</span></p>
Minor version; defaults to the environment's pin.
</li>
</ul>

## Request body

<ul class="api-fields">
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">kind</code> <span class="api-field__type">string</span> <span class="api-field__required">Required</span></p>

<p class="api-field__chips">one of <code>github</code>, <code>google</code>, <code>slack</code>, <code>salesforce</code>, <code>hubspot</code>, <code>linear</code>, <code>notion</code>, <code>oauth2</code></p>
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">client_id</code> <span class="api-field__type">string</span> <span class="api-field__required">Required</span></p>

<p class="api-field__chips">min length 1 · max length 512</p>
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">client_secret</code> <span class="api-field__type">string</span> <span class="api-field__required">Required</span></p>

<p class="api-field__chips">min length 1 · max length 4096</p>
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">scopes</code> <span class="api-field__type">array of string</span></p>

<p class="api-field__chips">max items 100</p>
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">authorize_url</code> <span class="api-field__type">string</span></p>

<p class="api-field__chips">max length 2048</p>
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">token_url</code> <span class="api-field__type">string</span></p>

<p class="api-field__chips">max length 2048</p>
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">revoke_url</code> <span class="api-field__type">string</span></p>

<p class="api-field__chips">max length 2048</p>
</li>
</ul>

## Responses

<ul class="api-responses">
<li class="api-response"><span class="api-status api-status--ok">200</span> <span>OK <span class="api-field__type">PipeProvider</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">400</span> <span>Invalid request. Codes: <a href="/errors/parameter_invalid/">parameter_invalid</a>, <a href="/errors/parameter_missing/">parameter_missing</a>, <a href="/errors/version_unsupported/">version_unsupported</a> and resource-specific codes from the catalogue. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">401</span> <span>Codes: <a href="/errors/authentication_required/">authentication_required</a>, <a href="/errors/api_key_invalid/">api_key_invalid</a>. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">403</span> <span>Codes: <a href="/errors/api_key_scope_missing/">api_key_scope_missing</a>, <a href="/errors/ip_not_allowed/">ip_not_allowed</a>, <a href="/errors/plan_limit_reached/">plan_limit_reached</a>. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">409</span> <span>Codes: <a href="/errors/idempotency_key_reused/">idempotency_key_reused</a> and resource-specific conflicts. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">429</span> <span>Code: <a href="/errors/rate_limited/">rate_limited</a>. Retry-After is set. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">503</span> <span>Code: <a href="/errors/service_unavailable/">service_unavailable</a>. Retry-After is set; writes are paused. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--neutral">default</span> <span>Any other error, including <a href="/errors/internal_error/">internal_error</a>. Every code is in the error catalogue. <span class="api-field__type">Error</span></span></li>
</ul>

Errors share one shape; see the [error code catalogue](/errors/).

</div>
<div class="api-op__code">

**curl**

```sh wrap
curl -X PUT \
  "https://api.ohauthcat.com/v1/pipes/providers/okta" \
  -H "Authorization: Bearer $OHAUTHCAT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "kind": "github",
  "client_id": "client_01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
  "client_secret": "sk_test_example"
}'
```

**Node**

```javascript wrap
const response = await fetch(
  "https://api.ohauthcat.com/v1/pipes/providers/okta",
  {
    method: "PUT",
    headers: {
      Authorization: `Bearer ${process.env.OHAUTHCAT_API_KEY}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      kind: "github",
      client_id: "client_01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
      client_secret: "sk_test_example",
    }),
  },
);
const data = await response.json();
```

**Python**

```python wrap
import os
import requests

response = requests.put(
    "https://api.ohauthcat.com/v1/pipes/providers/okta",
    headers={"Authorization": f"Bearer {os.environ['OHAUTHCAT_API_KEY']}"},
    json={
        "kind": "github",
        "client_id": "client_01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
        "client_secret": "sk_test_example",
    },
)
data = response.json()
```

```json title="Response 200" wrap
{
  "object": "pipe_provider",
  "provider": "okta",
  "kind": "default",
  "client_id": "client_01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
  "scopes": ["organizations:read"],
  "authorize_url": "https://app.acme.com/callback",
  "token_url": "https://app.acme.com/callback",
  "revoke_url": "https://app.acme.com/callback",
  "created_at": "2026-01-15T09:30:00Z",
  "updated_at": "2026-01-15T09:30:00Z"
}
```

</div>
</div>
