Sign in

v2

latestOpenAPI 3.1.02026-07-312303692.4 MB
Endpoint

Create Sink

Create a new sink for the application.

post/api/v1/app/{app_id}/sink

Path parameters

app_idstring required

The Application's ID or UID.

Example:unique-identifier

The Application's ID or UID.

Headers

idempotency-keystring

The request's idempotency key

Request body

OR
OR

Example request

{
  "description": "An example endpoint name",
  "uid": "unique-identifier",
  "secret": "whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD",
  "filterTypes": [
    "user.signup",
    "user.deleted"
  ],
  "channels": [
    "project_123",
    "group_2"
  ]
}

Response

OR
OR

Example response

{
  "id": "ep_1srOrx2ZWZBpBUvZwXKQmoEYga2",
  "uid": "unique-identifier",
  "filterTypes": [
    "user.signup",
    "user.deleted"
  ],
  "channels": [
    "project_123",
    "group_2"
  ]
}