Skip to content
Dashboard
Theme
Theme

Create an SSF transmitter stream

POST /v1/ssf_streams: Create an SSF transmitter stream.

View Markdown

POST /v1/ssf_streams

Scope
signals:write
Auth
Secret key (sk_…)
Since
1.0
  • OhAuthCat-Version string

    Minor version; defaults to the environment’s pin.

  • Idempotency-Key string

    Honoured for 24 h; a replay returns the original response.

    min length 1 · max length 255

  • delivery_method string

    Defaults to poll.

    one of push, poll

  • endpoint_url string

    Push streams only; an https URL.

    max length 2048

  • authorization_header string

    Push streams only; sealed at rest and never shown again.

    max length 4096

  • events_requested array of string

    max items 32

  • description string

    max length 256

  • status string

    one of enabled, paused, disabled

Errors share one shape; see the error code catalogue.

curl -X POST \
"https://api.ohauthcat.com/v1/ssf_streams" \
-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"
}'
Response 201
{
"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"
}