Sign in

v2

latestOpenAPI 3.1.02026-07-312303692.4 MB
Sink

Create Sink

Creates a new sink.

post/api/v1/stream/{stream_id}/sink

Path parameters

stream_idstring required

The Stream's ID or UID.

Example:unique-identifier

The Stream's ID or UID.

Headers

idempotency-keystring

The request's idempotency key

Request body

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

Example request

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

Response

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

Example response

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