Skip to content
Dashboard
Theme
Theme

Configure a Pipes provider

PUT /v1/pipes/providers/{provider}: Configure a Pipes provider.

View Markdown

PUT /v1/pipes/providers/{provider}

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.

Scope
pipes:write
Auth
Secret key (sk_…)
Since
1.1
  • provider string Required

  • OhAuthCat-Version string

    Minor version; defaults to the environment’s pin.

  • kind string Required

    one of github, google, slack, salesforce, hubspot, linear, notion, oauth2

  • client_id string Required

    min length 1 · max length 512

  • client_secret string Required

    min length 1 · max length 4096

  • scopes array of string

    max items 100

  • authorize_url string

    max length 2048

  • token_url string

    max length 2048

  • revoke_url string

    max length 2048

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"
}'
Response 200
{
"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"
}