> ## Documentation Index > Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt > Use this file to discover all available pages before exploring further. # svix-streaming > Svix Streaming - manage streams, sinks, stream event types, stream auth **Server path:** `/svix-streaming` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | ----------------------------------------------------------------------------------------------------------------------------------- | ------------------------- | | [`svix_streaming_v1_authentication_get_stream_poller_token`](#svix_streaming_v1_authentication_get_stream_poller_token) | Get Poller Token | | [`svix_streaming_v1_authentication_rotate_stream_poller_token`](#svix_streaming_v1_authentication_rotate_stream_poller_token) | Rotate Poller Token | | [`svix_streaming_v1_authentication_stream_expire_all`](#svix_streaming_v1_authentication_stream_expire_all) | Stream Expire All | | [`svix_streaming_v1_authentication_stream_logout`](#svix_streaming_v1_authentication_stream_logout) | Stream Logout | | [`svix_streaming_v1_authentication_stream_portal_access`](#svix_streaming_v1_authentication_stream_portal_access) | Get Stream Portal Access | | [`svix_streaming_v1_streaming_event_type_create`](#svix_streaming_v1_streaming_event_type_create) | Create Stream Event Type | | [`svix_streaming_v1_streaming_event_type_delete`](#svix_streaming_v1_streaming_event_type_delete) | Delete Stream Event Type | | [`svix_streaming_v1_streaming_event_type_get`](#svix_streaming_v1_streaming_event_type_get) | Get Stream Event Type | | [`svix_streaming_v1_streaming_event_type_list`](#svix_streaming_v1_streaming_event_type_list) | List Stream Event Types | | [`svix_streaming_v1_streaming_event_type_patch`](#svix_streaming_v1_streaming_event_type_patch) | Patch Stream Event Type | | [`svix_streaming_v1_streaming_event_type_update`](#svix_streaming_v1_streaming_event_type_update) | Update Stream Event Type | | [`svix_streaming_v1_streaming_events_create`](#svix_streaming_v1_streaming_events_create) | Create Events | | [`svix_streaming_v1_streaming_events_get`](#svix_streaming_v1_streaming_events_get) | Poller Sink Stream Events | | [`svix_streaming_v1_streaming_sink_create`](#svix_streaming_v1_streaming_sink_create) | Create Sink | | [`svix_streaming_v1_streaming_sink_delete`](#svix_streaming_v1_streaming_sink_delete) | Delete Sink | | [`svix_streaming_v1_streaming_sink_get`](#svix_streaming_v1_streaming_sink_get) | Get Sink | | [`svix_streaming_v1_streaming_sink_get_secret`](#svix_streaming_v1_streaming_sink_get_secret) | Get Sink Secret | | [`svix_streaming_v1_streaming_sink_headers_get`](#svix_streaming_v1_streaming_sink_headers_get) | Get Sink Headers | | [`svix_streaming_v1_streaming_sink_headers_patch`](#svix_streaming_v1_streaming_sink_headers_patch) | Patch Sink Headers | | [`svix_streaming_v1_streaming_sink_list`](#svix_streaming_v1_streaming_sink_list) | List Sinks | | [`svix_streaming_v1_streaming_sink_patch`](#svix_streaming_v1_streaming_sink_patch) | Patch Sink | | [`svix_streaming_v1_streaming_sink_rotate_secret`](#svix_streaming_v1_streaming_sink_rotate_secret) | Rotate Sink Secret | | [`svix_streaming_v1_streaming_sink_transformation_get`](#svix_streaming_v1_streaming_sink_transformation_get) | Get Sink Transformation | | [`svix_streaming_v1_streaming_sink_transformation_partial_update`](#svix_streaming_v1_streaming_sink_transformation_partial_update) | Set Sink Transformation | | [`svix_streaming_v1_streaming_sink_update`](#svix_streaming_v1_streaming_sink_update) | Update Sink | | [`svix_streaming_v1_streaming_stream_create`](#svix_streaming_v1_streaming_stream_create) | Create Stream | | [`svix_streaming_v1_streaming_stream_delete`](#svix_streaming_v1_streaming_stream_delete) | Delete Stream | | [`svix_streaming_v1_streaming_stream_get`](#svix_streaming_v1_streaming_stream_get) | Get Stream | | [`svix_streaming_v1_streaming_stream_list`](#svix_streaming_v1_streaming_stream_list) | List Streams | | [`svix_streaming_v1_streaming_stream_patch`](#svix_streaming_v1_streaming_stream_patch) | Patch Stream | | [`svix_streaming_v1_streaming_stream_update`](#svix_streaming_v1_streaming_stream_update) | Update Stream | *** ## svix\_streaming\_v1\_authentication\_get\_stream\_poller\_token Get Poller Token **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | --------------------------- | | `stream_id` | string | Yes | — | The Stream's ID or UID. | | `sink_id` | string | Yes | — | The StreamSink's ID or UID. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "stream_id": { "type": "string", "description": "The Stream's ID or UID." }, "sink_id": { "type": "string", "description": "The StreamSink's ID or UID." } }, "required": [ "PCID", "stream_id", "sink_id" ] } ``` *** ## svix\_streaming\_v1\_authentication\_rotate\_stream\_poller\_token Rotate Poller Token **Parameters:** | Parameter | Type | Required | Default | Description | | | ----------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | | `stream_id` | string | Yes | — | The Stream's ID or UID. | | | `sink_id` | string | Yes | — | The StreamSink's ID or UID. | | | `idempotency-key` | string | No | — | The request's idempotency key | | | `expiry` | integer | null | No | — | How long the token will be valid for, in seconds. Can be up to 31,536,000 seconds (1 year). | | `oldTokenExpiry` | integer | No | — | Updates the previous token's expiration, in seconds. If set to 0, the old token will immediately be revoked. Must be between 0 and 86,400 seconds (1 day). Defaults to 300 seconds (5 minutes). | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "stream_id": { "type": "string", "description": "The Stream's ID or UID." }, "sink_id": { "type": "string", "description": "The StreamSink's ID or UID." }, "idempotency-key": { "type": "string", "description": "The request's idempotency key" }, "expiry": { "type": [ "integer", "null" ], "description": "How long the token will be valid for, in seconds. Can be up to 31,536,000 seconds (1 year)." }, "oldTokenExpiry": { "type": "integer", "description": "Updates the previous token's expiration, in seconds. If set to 0, the old token will immediately be revoked. Must be between 0 and 86,400 seconds (1 day). Defaults to 300 seconds (5 minutes)." } }, "required": [ "PCID", "stream_id", "sink_id" ] } ``` *** ## svix\_streaming\_v1\_authentication\_stream\_expire\_all Stream Expire All **Parameters:** | Parameter | Type | Required | Default | Description | | | ----------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------- | | `stream_id` | string | Yes | — | The Stream's ID or UID. | | | `idempotency-key` | string | No | — | The request's idempotency key | | | `expiry` | integer | null | No | — | How many seconds until the old key is expired. | | `sessionIds` | string\[] | No | — | An optional list of session ids. If any session ids are specified, only Stream tokens created with that session id will be expired. | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "stream_id": { "type": "string", "description": "The Stream's ID or UID." }, "idempotency-key": { "type": "string", "description": "The request's idempotency key" }, "expiry": { "type": [ "integer", "null" ], "description": "How many seconds until the old key is expired." }, "sessionIds": { "type": "array", "items": { "type": "string" }, "description": "An optional list of session ids. If any session ids are specified, only Stream tokens created with that session id will be expired." } }, "required": [ "PCID", "stream_id" ] } ``` *** ## svix\_streaming\_v1\_authentication\_stream\_logout Stream Logout **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | ----------------------------- | | `idempotency-key` | string | No | — | The request's idempotency key | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "idempotency-key": { "type": "string", "description": "The request's idempotency key" } }, "required": [ "PCID" ] } ``` *** ## svix\_streaming\_v1\_authentication\_stream\_portal\_access Get Stream Portal Access **Parameters:** | Parameter | Type | Required | Default | Description | | | ----------------- | --------- | -------- | ------- | --------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `stream_id` | string | Yes | — | The Stream's ID or UID. | | | `idempotency-key` | string | No | — | The request's idempotency key | | | `expiry` | integer | null | No | — | How long the token will be valid for, in seconds. Valid values are between 1 hour and 7 days. The default is 7 days. | | `featureFlags` | string\[] | No | — | The set of feature flags the created token will have access to. | | | `sessionId` | string | null | No | — | An optional session ID to attach to the token. When expiring tokens with "Expire All", you can include the session ID to only expire tokens that were created with that session ID. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "stream_id": { "type": "string", "description": "The Stream's ID or UID." }, "idempotency-key": { "type": "string", "description": "The request's idempotency key" }, "expiry": { "type": [ "integer", "null" ], "description": "How long the token will be valid for, in seconds. Valid values are between 1 hour and 7 days. The default is 7 days." }, "featureFlags": { "type": "array", "items": { "type": "string" }, "description": "The set of feature flags the created token will have access to." }, "sessionId": { "type": [ "string", "null" ], "description": "An optional session ID to attach to the token. When expiring tokens with \"Expire All\", you can include the session ID to only expire tokens that were created with that session ID." } }, "required": [ "PCID", "stream_id" ] } ``` *** ## svix\_streaming\_v1\_streaming\_event\_type\_create Create Stream Event Type **Parameters:** | Parameter | Type | Required | Default | Description | | | ----------------- | --------- | -------- | ------- | ----------------------------- | --------------------- | | `idempotency-key` | string | No | — | The request's idempotency key | | | `archived` | boolean | No | — | The archived value | | | `deprecated` | boolean | No | — | The deprecated value | | | `description` | string | null | No | — | The description value | | `featureFlags` | string\[] | No | — | Feature Flags | | | `name` | string | Yes | — | The event type's name | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "idempotency-key": { "type": "string", "description": "The request's idempotency key" }, "archived": { "type": "boolean", "description": "The archived value" }, "deprecated": { "type": "boolean", "description": "The deprecated value" }, "description": { "type": [ "string", "null" ], "description": "The description value" }, "featureFlags": { "type": "array", "items": { "type": "string" }, "description": "Feature Flags" }, "name": { "type": "string", "description": "The event type's name" } }, "required": [ "PCID", "name" ] } ``` *** ## svix\_streaming\_v1\_streaming\_event\_type\_delete Delete Stream Event Type **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ----------------------------------------------------------------------------------------------- | | `name` | string | Yes | — | The event type's name | | `expunge` | boolean | No | — | By default, event types are archived when "deleted". With this flag, they are deleted entirely. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "name": { "type": "string", "description": "The event type's name" }, "expunge": { "type": "boolean", "description": "By default, event types are archived when \"deleted\". With this flag, they are deleted entirely." } }, "required": [ "PCID", "name" ] } ``` *** ## svix\_streaming\_v1\_streaming\_event\_type\_get Get Stream Event Type **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | --------------------- | | `name` | string | Yes | — | The event type's name | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "name": { "type": "string", "description": "The event type's name" } }, "required": [ "PCID", "name" ] } ``` *** ## svix\_streaming\_v1\_streaming\_event\_type\_list List Stream Event Types **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | ------- | -------- | ------- | ------------------------------------------------------------------ | | `limit` | integer | No | — | Limit the number of returned items | | `iterator` | string | No | — | The iterator returned from a prior invocation | | `order` | string | No | — | The sorting order of the returned items | | `include_archived` | boolean | No | — | Include archived (deleted but not expunged) items in the response. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "limit": { "type": "integer", "description": "Limit the number of returned items" }, "iterator": { "type": "string", "description": "The iterator returned from a prior invocation" }, "order": { "type": "string", "description": "The sorting order of the returned items", "enum": [ "ascending", "descending" ] }, "include_archived": { "type": "boolean", "description": "Include archived (deleted but not expunged) items in the response." } }, "required": [ "PCID" ] } ``` *** ## svix\_streaming\_v1\_streaming\_event\_type\_patch Patch Stream Event Type **Parameters:** | Parameter | Type | Required | Default | Description | | | -------------- | --------- | -------- | ------- | --------------------- | --------------------- | | `name` | string | Yes | — | The event type's name | | | `archived` | boolean | No | — | The archived value | | | `deprecated` | boolean | No | — | The deprecated value | | | `description` | string | null | No | — | The description value | | `featureFlags` | string\[] | No | — | Feature Flags | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "name": { "type": "string", "description": "The event type's name" }, "archived": { "type": "boolean", "description": "The archived value" }, "deprecated": { "type": "boolean", "description": "The deprecated value" }, "description": { "type": [ "string", "null" ], "description": "The description value" }, "featureFlags": { "type": "array", "items": { "type": "string" }, "description": "Feature Flags" } }, "required": [ "PCID", "name" ] } ``` *** ## svix\_streaming\_v1\_streaming\_event\_type\_update Update Stream Event Type **Parameters:** | Parameter | Type | Required | Default | Description | | | -------------- | --------- | -------- | ------- | --------------------- | --------------------- | | `name` | string | Yes | — | The event type's name | | | `archived` | boolean | No | — | The archived value | | | `deprecated` | boolean | No | — | The deprecated value | | | `description` | string | null | No | — | The description value | | `featureFlags` | string\[] | No | — | Feature Flags | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "name": { "type": "string", "description": "The event type's name" }, "archived": { "type": "boolean", "description": "The archived value" }, "deprecated": { "type": "boolean", "description": "The deprecated value" }, "description": { "type": [ "string", "null" ], "description": "The description value" }, "featureFlags": { "type": "array", "items": { "type": "string" }, "description": "Feature Flags" } }, "required": [ "PCID", "name" ] } ``` *** ## svix\_streaming\_v1\_streaming\_events\_create Create Events **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | --------- | -------- | ------- | ----------------------------- | | `stream_id` | string | Yes | — | The Stream's ID or UID. | | `idempotency-key` | string | No | — | The request's idempotency key | | `events` | object\[] | Yes | — | The events value | | `stream` | object | No | — | The stream value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "stream_id": { "type": "string", "description": "The Stream's ID or UID." }, "idempotency-key": { "type": "string", "description": "The request's idempotency key" }, "events": { "type": "array", "items": { "type": "object", "properties": { "eventType": { "type": "string", "description": "The event type's name" }, "payload": { "type": "string", "description": "The payload value" } }, "required": [ "eventType", "payload" ] }, "description": "The events value" }, "stream": { "type": "object", "description": "The stream value", "properties": { "metadata": { "type": "object", "description": "The metadata value" }, "name": { "type": "string", "description": "The stream's name." }, "uid": { "type": "string", "description": "An optional unique identifier for the stream." } }, "required": [ "name" ] } }, "required": [ "PCID", "stream_id", "events" ] } ``` *** ## svix\_streaming\_v1\_streaming\_events\_get Poller Sink Stream Events **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------- | -------- | ------- | --------------------------------------------- | | `stream_id` | string | Yes | — | The Stream's ID or UID. | | `sink_id` | string | Yes | — | The StreamSink's ID or UID. | | `limit` | integer | No | — | Limit the number of returned items | | `iterator` | string | No | — | The iterator returned from a prior invocation | | `after` | string | No | — | The after value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "stream_id": { "type": "string", "description": "The Stream's ID or UID." }, "sink_id": { "type": "string", "description": "The StreamSink's ID or UID." }, "limit": { "type": "integer", "description": "Limit the number of returned items" }, "iterator": { "type": "string", "description": "The iterator returned from a prior invocation" }, "after": { "type": "string", "description": "The after value" } }, "required": [ "PCID", "stream_id", "sink_id" ] } ``` *** ## svix\_streaming\_v1\_streaming\_sink\_create Create Sink **Parameters:** | Parameter | Type | Required | Default | Description | | | ----------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- | | `stream_id` | string | Yes | — | The Stream's ID or UID. | | | `idempotency-key` | string | No | — | The request's idempotency key | | | `batchSize` | integer | No | — | How many events will be batched in a request to the Sink. | | | `eventTypes` | string\[] | No | — | A list of event types that filter which events are dispatched to the Sink. An empty list (or null) will not filter out any events. | | | `maxWaitSecs` | integer | No | — | How long to wait before a batch of events is sent, if the `batchSize` is not reached. For example, with a `batchSize` of 100 and `maxWaitSecs` of 10, we will send a request after 10 seconds or 100 events, whichever comes first. Note that we will never send an empty batch of events to the Sink. | | | `metadata` | object | No | — | The metadata value | | | `status` | string | No | — | The status value | | | `uid` | string | null | No | — | An optional unique identifier for the sink. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "stream_id": { "type": "string", "description": "The Stream's ID or UID." }, "idempotency-key": { "type": "string", "description": "The request's idempotency key" }, "batchSize": { "type": "integer", "description": "How many events will be batched in a request to the Sink." }, "eventTypes": { "type": "array", "items": { "type": "string" }, "description": "A list of event types that filter which events are dispatched to the Sink. An empty list (or null) will not filter out any events." }, "maxWaitSecs": { "type": "integer", "description": "How long to wait before a batch of events is sent, if the `batchSize` is not reached. For example, with a `batchSize` of 100 and `maxWaitSecs` of 10, we will send a request after 10 seconds or 100 events, whichever comes first. Note that we will never send an empty batch of events to the Sink." }, "metadata": { "type": "object", "description": "The metadata value" }, "status": { "type": "string", "description": "The status value", "enum": [ "enabled", "disabled" ] }, "uid": { "type": [ "string", "null" ], "description": "An optional unique identifier for the sink." } }, "required": [ "PCID", "stream_id" ] } ``` *** ## svix\_streaming\_v1\_streaming\_sink\_delete Delete Sink **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | --------------------------- | | `stream_id` | string | Yes | — | The Stream's ID or UID. | | `sink_id` | string | Yes | — | The StreamSink's ID or UID. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "stream_id": { "type": "string", "description": "The Stream's ID or UID." }, "sink_id": { "type": "string", "description": "The StreamSink's ID or UID." } }, "required": [ "PCID", "stream_id", "sink_id" ] } ``` *** ## svix\_streaming\_v1\_streaming\_sink\_get Get Sink **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | --------------------------- | | `stream_id` | string | Yes | — | The Stream's ID or UID. | | `sink_id` | string | Yes | — | The StreamSink's ID or UID. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "stream_id": { "type": "string", "description": "The Stream's ID or UID." }, "sink_id": { "type": "string", "description": "The StreamSink's ID or UID." } }, "required": [ "PCID", "stream_id", "sink_id" ] } ``` *** ## svix\_streaming\_v1\_streaming\_sink\_get\_secret Get Sink Secret **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | --------------------------- | | `stream_id` | string | Yes | — | The Stream's ID or UID. | | `sink_id` | string | Yes | — | The StreamSink's ID or UID. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "stream_id": { "type": "string", "description": "The Stream's ID or UID." }, "sink_id": { "type": "string", "description": "The StreamSink's ID or UID." } }, "required": [ "PCID", "stream_id", "sink_id" ] } ``` *** ## svix\_streaming\_v1\_streaming\_sink\_headers\_get Get Sink Headers **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | --------------------------- | | `stream_id` | string | Yes | — | The Stream's ID or UID. | | `sink_id` | string | Yes | — | The StreamSink's ID or UID. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "stream_id": { "type": "string", "description": "The Stream's ID or UID." }, "sink_id": { "type": "string", "description": "The StreamSink's ID or UID." } }, "required": [ "PCID", "stream_id", "sink_id" ] } ``` *** ## svix\_streaming\_v1\_streaming\_sink\_headers\_patch Patch Sink Headers **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | --------------------------- | | `stream_id` | string | Yes | — | The Stream's ID or UID. | | `sink_id` | string | Yes | — | The StreamSink's ID or UID. | | `headers` | object | Yes | — | The headers value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "stream_id": { "type": "string", "description": "The Stream's ID or UID." }, "sink_id": { "type": "string", "description": "The StreamSink's ID or UID." }, "headers": { "type": "object", "description": "The headers value" } }, "required": [ "PCID", "stream_id", "sink_id", "headers" ] } ``` *** ## svix\_streaming\_v1\_streaming\_sink\_list List Sinks **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------- | -------- | ------- | --------------------------------------------- | | `stream_id` | string | Yes | — | The Stream's ID or UID. | | `limit` | integer | No | — | Limit the number of returned items | | `iterator` | string | No | — | The iterator returned from a prior invocation | | `order` | string | No | — | The sorting order of the returned items | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "stream_id": { "type": "string", "description": "The Stream's ID or UID." }, "limit": { "type": "integer", "description": "Limit the number of returned items" }, "iterator": { "type": "string", "description": "The iterator returned from a prior invocation" }, "order": { "type": "string", "description": "The sorting order of the returned items", "enum": [ "ascending", "descending" ] } }, "required": [ "PCID", "stream_id" ] } ``` *** ## svix\_streaming\_v1\_streaming\_sink\_patch Patch Sink **Parameters:** | Parameter | Type | Required | Default | Description | | | ------------- | --------- | -------- | ------- | --------------------------- | --------------------- | | `stream_id` | string | Yes | — | The Stream's ID or UID. | | | `sink_id` | string | Yes | — | The StreamSink's ID or UID. | | | `batchSize` | integer | null | No | — | Batch Size | | `eventTypes` | string\[] | No | — | Event Types | | | `maxWaitSecs` | integer | null | No | — | Max Wait Secs | | `metadata` | object | No | — | The metadata value | | | `status` | string | No | — | The status value | | | `uid` | string | null | No | — | The StreamSink's UID. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "stream_id": { "type": "string", "description": "The Stream's ID or UID." }, "sink_id": { "type": "string", "description": "The StreamSink's ID or UID." }, "batchSize": { "type": [ "integer", "null" ], "description": "Batch Size" }, "eventTypes": { "type": "array", "items": { "type": "string" }, "description": "Event Types" }, "maxWaitSecs": { "type": [ "integer", "null" ], "description": "Max Wait Secs" }, "metadata": { "type": "object", "description": "The metadata value" }, "status": { "type": "string", "description": "The status value", "enum": [ "enabled", "disabled" ] }, "uid": { "type": [ "string", "null" ], "description": "The StreamSink's UID." } }, "required": [ "PCID", "stream_id", "sink_id" ] } ``` *** ## svix\_streaming\_v1\_streaming\_sink\_rotate\_secret Rotate Sink Secret **Parameters:** | Parameter | Type | Required | Default | Description | | | ----------------- | ------ | -------- | ------- | ----------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `stream_id` | string | Yes | — | The Stream's ID or UID. | | | `sink_id` | string | Yes | — | The StreamSink's ID or UID. | | | `idempotency-key` | string | No | — | The request's idempotency key | | | `key` | string | null | No | — | The endpoint's verification secret. Format: `base64` encoded random bytes optionally prefixed with `whsec_`. It is recommended to not set this and let the server generate the secret. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "stream_id": { "type": "string", "description": "The Stream's ID or UID." }, "sink_id": { "type": "string", "description": "The StreamSink's ID or UID." }, "idempotency-key": { "type": "string", "description": "The request's idempotency key" }, "key": { "type": [ "string", "null" ], "description": "The endpoint's verification secret. Format: `base64` encoded random bytes optionally prefixed with `whsec_`. It is recommended to not set this and let the server generate the secret." } }, "required": [ "PCID", "stream_id", "sink_id" ] } ``` *** ## svix\_streaming\_v1\_streaming\_sink\_transformation\_get Get Sink Transformation **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | --------------------------- | | `stream_id` | string | Yes | — | The Stream's ID or UID. | | `sink_id` | string | Yes | — | The StreamSink's ID or UID. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "stream_id": { "type": "string", "description": "The Stream's ID or UID." }, "sink_id": { "type": "string", "description": "The StreamSink's ID or UID." } }, "required": [ "PCID", "stream_id", "sink_id" ] } ``` *** ## svix\_streaming\_v1\_streaming\_sink\_transformation\_partial\_update Set Sink Transformation **Parameters:** | Parameter | Type | Required | Default | Description | | | ----------- | ------ | -------- | ------- | --------------------------- | -------------- | | `stream_id` | string | Yes | — | The Stream's ID or UID. | | | `sink_id` | string | Yes | — | The StreamSink's ID or UID. | | | `code` | string | null | No | — | The code value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "stream_id": { "type": "string", "description": "The Stream's ID or UID." }, "sink_id": { "type": "string", "description": "The StreamSink's ID or UID." }, "code": { "type": [ "string", "null" ], "description": "The code value" } }, "required": [ "PCID", "stream_id", "sink_id" ] } ``` *** ## svix\_streaming\_v1\_streaming\_sink\_update Update Sink **Parameters:** | Parameter | Type | Required | Default | Description | | | ------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- | | `stream_id` | string | Yes | — | The Stream's ID or UID. | | | `sink_id` | string | Yes | — | The StreamSink's ID or UID. | | | `batchSize` | integer | No | — | How many events will be batched in a request to the Sink. | | | `eventTypes` | string\[] | No | — | A list of event types that filter which events are dispatched to the Sink. An empty list (or null) will not filter out any events. | | | `maxWaitSecs` | integer | No | — | How long to wait before a batch of events is sent, if the `batchSize` is not reached. For example, with a `batchSize` of 100 and `maxWaitSecs` of 10, we will send a request after 10 seconds or 100 events, whichever comes first. Note that we will never send an empty batch of events to the Sink. | | | `metadata` | object | No | — | The metadata value | | | `status` | string | No | — | The status value | | | `uid` | string | null | No | — | An optional unique identifier for the sink. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "stream_id": { "type": "string", "description": "The Stream's ID or UID." }, "sink_id": { "type": "string", "description": "The StreamSink's ID or UID." }, "batchSize": { "type": "integer", "description": "How many events will be batched in a request to the Sink." }, "eventTypes": { "type": "array", "items": { "type": "string" }, "description": "A list of event types that filter which events are dispatched to the Sink. An empty list (or null) will not filter out any events." }, "maxWaitSecs": { "type": "integer", "description": "How long to wait before a batch of events is sent, if the `batchSize` is not reached. For example, with a `batchSize` of 100 and `maxWaitSecs` of 10, we will send a request after 10 seconds or 100 events, whichever comes first. Note that we will never send an empty batch of events to the Sink." }, "metadata": { "type": "object", "description": "The metadata value" }, "status": { "type": "string", "description": "The status value", "enum": [ "enabled", "disabled" ] }, "uid": { "type": [ "string", "null" ], "description": "An optional unique identifier for the sink." } }, "required": [ "PCID", "stream_id", "sink_id" ] } ``` *** ## svix\_streaming\_v1\_streaming\_stream\_create Create Stream **Parameters:** | Parameter | Type | Required | Default | Description | | | ----------------- | ------ | -------- | ------- | ----------------------------- | --------------------------------------------- | | `idempotency-key` | string | No | — | The request's idempotency key | | | `metadata` | object | No | — | The metadata value | | | `name` | string | Yes | — | The stream's name. | | | `uid` | string | null | No | — | An optional unique identifier for the stream. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "idempotency-key": { "type": "string", "description": "The request's idempotency key" }, "metadata": { "type": "object", "description": "The metadata value" }, "name": { "type": "string", "description": "The stream's name." }, "uid": { "type": [ "string", "null" ], "description": "An optional unique identifier for the stream." } }, "required": [ "PCID", "name" ] } ``` *** ## svix\_streaming\_v1\_streaming\_stream\_delete Delete Stream **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | ----------------------- | | `stream_id` | string | Yes | — | The Stream's ID or UID. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "stream_id": { "type": "string", "description": "The Stream's ID or UID." } }, "required": [ "PCID", "stream_id" ] } ``` *** ## svix\_streaming\_v1\_streaming\_stream\_get Get Stream **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | ----------------------- | | `stream_id` | string | Yes | — | The Stream's ID or UID. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "stream_id": { "type": "string", "description": "The Stream's ID or UID." } }, "required": [ "PCID", "stream_id" ] } ``` *** ## svix\_streaming\_v1\_streaming\_stream\_list List Streams **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------- | -------- | ------- | --------------------------------------------- | | `limit` | integer | No | — | Limit the number of returned items | | `iterator` | string | No | — | The iterator returned from a prior invocation | | `order` | string | No | — | The sorting order of the returned items | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "limit": { "type": "integer", "description": "Limit the number of returned items" }, "iterator": { "type": "string", "description": "The iterator returned from a prior invocation" }, "order": { "type": "string", "description": "The sorting order of the returned items", "enum": [ "ascending", "descending" ] } }, "required": [ "PCID" ] } ``` *** ## svix\_streaming\_v1\_streaming\_stream\_patch Patch Stream **Parameters:** | Parameter | Type | Required | Default | Description | | | ------------- | ------ | -------- | ------- | ------------------------- | --------------------------------------------- | | `stream_id` | string | Yes | — | The Stream's ID or UID. | | | `description` | string | No | — | The Stream's description. | | | `metadata` | object | No | — | The metadata value | | | `uid` | string | null | No | — | An optional unique identifier for the stream. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "stream_id": { "type": "string", "description": "The Stream's ID or UID." }, "description": { "type": "string", "description": "The Stream's description." }, "metadata": { "type": "object", "description": "The metadata value" }, "uid": { "type": [ "string", "null" ], "description": "An optional unique identifier for the stream." } }, "required": [ "PCID", "stream_id" ] } ``` *** ## svix\_streaming\_v1\_streaming\_stream\_update Update Stream **Parameters:** | Parameter | Type | Required | Default | Description | | | ----------- | ------ | -------- | ------- | ----------------------- | --------------------------------------------- | | `stream_id` | string | Yes | — | The Stream's ID or UID. | | | `metadata` | object | No | — | The metadata value | | | `name` | string | Yes | — | The stream's name. | | | `uid` | string | null | No | — | An optional unique identifier for the stream. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "stream_id": { "type": "string", "description": "The Stream's ID or UID." }, "metadata": { "type": "object", "description": "The metadata value" }, "name": { "type": "string", "description": "The stream's name." }, "uid": { "type": [ "string", "null" ], "description": "An optional unique identifier for the stream." } }, "required": [ "PCID", "stream_id", "name" ] } ```