Configure a Pipes provider
PUT /v1/pipes/providers/{provider}: Configure a Pipes provider.
PUT /
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: 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.
- Scope
pipes:write- Auth
- Secret key (
sk_…) - Since
- 1.1
Path parameters
Section titled “Path parameters”providerstring Required
Headers
Section titled “Headers”
Minor version; defaults to the environment’s pin.OhAuthCat-Versionstring
Request body
Section titled “Request body”kindstring Requiredone of
github,google,slack,salesforce,hubspot,linear,notion,oauth2client_idstring Requiredmin length 1 · max length 512
client_secretstring Requiredmin length 1 · max length 4096
scopesarray of stringmax items 100
authorize_urlstringmax length 2048
token_urlstringmax length 2048
revoke_urlstringmax length 2048
Responses
Section titled “Responses”- 200 OK PipeProvider
- 400 Invalid request. Codes: parameter_invalid, parameter_missing, version_unsupported and resource-specific codes from the catalogue. Error
- 401 Codes: authentication_required, api_key_invalid. Error
- 403 Codes: api_key_scope_missing, ip_not_allowed, plan_limit_reached. Error
- 409 Codes: idempotency_key_reused and resource-specific conflicts. Error
- 429 Code: rate_limited. Retry-After is set. Error
- 503 Code: service_unavailable. Retry-After is set; writes are paused. Error
- default Any other error, including internal_error. Every code is in the error catalogue. Error
Errors share one shape; see the error code catalogue.
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"}'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();import osimport 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(){ "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"}