SVsvix
Sink

Upsert Sink

Changed on

Create or update a sink.

put/api/v1/stream/{stream_id}/sink/{sink_id}

Request

  • Base URL
    https://api.eu.svix.com
  • URL
    https://api.eu.svix.com/api/v1/stream/{stream_id}/sink/{sink_id}
  • Auth
    HTTP bearer

Path parameters

stream_idstring required

The Stream's ID or UID.

Example:unique-identifier
sink_idstring required

The StreamSink's ID or UID.

Example:unique-identifier

Request body

OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR

Example request

{
  "batchSize": 100,
  "channels": [
    "project_1337"
  ],
  "eventTypes": [
    "user.signup"
  ],
  "uid": "unique-identifier"
}

Response

OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR

Example response

{
  "channels": [
    "project_1337"
  ],
  "eventTypes": [
    "user.signup"
  ],
  "id": "sink_2yZwUhtgs5Ai8T9yRQJXA",
  "uid": "unique-identifier"
}

Changes

  • 21bb0f86a732Revision changes
    • warning

      the ///// request property's maxLength was set to 512

  • 77555fa3a659Revision changes
    • breaking

      added to the response body oneOf list for the response status

    • breaking

      added to the response body oneOf list for the response status

    • info

      added postHog mapping keys to the request discriminator

    • info

      added to the request body oneOf list

    • info

      added postHog mapping keys to the response discriminator for the response status

    • info

      added postHog mapping keys to the response discriminator for the response status