Update an SSF transmitter stream
PATCH /v1/ssf_streams/{stream}: Update an SSF transmitter stream.
PATCH /
- Scope
signals:write- Auth
- Secret key (
sk_…) - Since
- 1.0
Path parameters
Section titled “Path parameters”streamstring Required
Headers
Section titled “Headers”
Minor version; defaults to the environment’s pin.OhAuthCat-Versionstring
Honoured for 24 h; a replay returns the original response.Idempotency-Keystringmin length 1 · max length 255
Request body
Section titled “Request body”
Defaults to poll.delivery_methodstringone of
push,poll
Push streams only; an https URL.endpoint_urlstringmax length 2048
Push streams only; sealed at rest and never shown again.authorization_headerstringmax length 4096
events_requestedarray of stringmax items 32
descriptionstringmax length 256
statusstringone of
enabled,paused,disabled
Responses
Section titled “Responses”- 200 OK SsfStream
- 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
- 404 Code: resource_not_found (also returned for other tenants’ IDs); a path no endpoint serves answers route_not_found. A browser GET or HEAD of an unknown path whose Accept ranks text/html above JSON gets an HTML 404 page instead, with the same status; every other client gets this JSON body. 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 PATCH \ "https://api.ohauthcat.com/v1/ssf_streams/ssft_01J9ZQ4M7K2X8V3N5B6C1D0E9F" \ -H "Authorization: Bearer $OHAUTHCAT_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "delivery_method": "push", "endpoint_url": "https://app.acme.com/callback", "authorization_header": "example_authorization_header", "events_requested": [ "user.signed_in" ], "description": "Primary SSO connection for Acme Corp.", "status": "enabled"}'const response = await fetch("https://api.ohauthcat.com/v1/ssf_streams/ssft_01J9ZQ4M7K2X8V3N5B6C1D0E9F", { method: "PATCH", headers: { Authorization: `Bearer ${process.env.OHAUTHCAT_API_KEY}`, "Content-Type": "application/json", }, body: JSON.stringify({ "delivery_method": "push", "endpoint_url": "https://app.acme.com/callback", "authorization_header": "example_authorization_header", "events_requested": [ "user.signed_in" ], "description": "Primary SSO connection for Acme Corp.", "status": "enabled" }),});const data = await response.json();import osimport requests
response = requests.patch( "https://api.ohauthcat.com/v1/ssf_streams/ssft_01J9ZQ4M7K2X8V3N5B6C1D0E9F", headers={"Authorization": f"Bearer {os.environ['OHAUTHCAT_API_KEY']}"}, json={ "delivery_method": "push", "endpoint_url": "https://app.acme.com/callback", "authorization_header": "example_authorization_header", "events_requested": [ "user.signed_in", ], "description": "Primary SSO connection for Acme Corp.", "status": "enabled", },)data = response.json(){ "id": "ssft_01J9ZQ4M7K2X8V3N5B6C1D0E9F", "object": "ssf_stream", "audience": "https://api.acme.com", "delivery_method": "push", "delivery_url": "https://app.acme.com/callback", "has_authorization_header": true, "events_requested": [ "user.signed_in" ], "events_delivered": [ "example_events_delivered" ], "description": "Primary SSO connection for Acme Corp.", "status": "enabled", "created_at": "2026-01-15T09:30:00Z", "updated_at": "2026-01-15T09:30:00Z"}