Event Types

Just like Svix Webhooks, each event sent through Svix Stream has an associated event type. Event types are identifiers denoting the type of event being sent, and are primarily used by Sinks to filter on events.

Event types are just a string, for example: user.signup, invoice.paid and workflow.completed.

You can see all of your environment's Stream Event Types under the "Event Types" tab in the Stream Dashboard.

You can create event types in the Stream Dashboard, or via the API.

JavaScript

import { Svix } from "svix";

const streamEventTypeOut = await svix.stream.eventType.create({
    name: "user.signup",
    description: null,
    featureFlags: ["cool-new-feature"]
});

Python

from svix.api import Svix, StreamEventTypeIn

stream_event_type_out = svix.stream.event_type.create(StreamEventTypeIn(
    name="user.signup",
    description=None,
    feature_flags=["cool-new-feature"]
))

Rust

import (
	svix "github.com/svix/svix-webhooks/go"
)

svixClient := svix.New("AUTH_TOKEN", nil)
streamEventTypeOut, err := svixClient.Stream.EventType.Create(ctx, &StreamEventTypeIn{
    Name: "user.signup",
    Description: nil,
    FeatureFlags: []string{"cool-new-feature"},
})

Go

let svix = Svix::new("AUTH_TOKEN".to_string(), None);
let stream_event_type_out = svix
    .stream()
    .event_type()
    .create(StreamEventTypeIn {
        name: "user.signup".to_string(),
        description: None,
        feature_flags: Some(vec!["cool-new-feature".to_string()]),
    }, None)
    .await?;

Java

import com.svix.Svix;
import com.svix.models.StreamEventTypeIn;


StreamEventTypeOut streamEventTypeOut = svix.getStream().getEventType().create(new StreamEventTypeIn()
    .name("user.signup")
    .description(null)
    .featureFlags(new String[]{"cool-new-feature"})
);

Kotlin

import com.svix.kotlin.Svix;
import com.svix.kotlin.models.StreamEventTypeIn;

val svix = Svix("AUTH_TOKEN");
val streamEventTypeOut = svix.stream.eventType.create(StreamEventTypeIn()
    .name("user.signup")
    .description(null)
    .featureFlags(arrayOf("cool-new-feature"))
)

Ruby

stream_event_type_out = svix.stream.event_type.create(Svix::StreamEventTypeIn.new({
    "name": "user.signup",
    "description": nil,
    "feature_flags": ["cool-new-feature"]
}))

C#

var svix = new SvixClient("AUTH_TOKEN", new SvixOptions("https://api.us.svix.com"));
var streamEventTypeOut = await svix.Stream.EventType.CreateAsync(new StreamEventTypeIn{
    name: "user.signup",
    description: null,
    featureFlags: new string[] {"cool-new-feature"}
});

PHP

Support for svix-cli coming soon

CLI

export SVIX_AUTH_TOKEN='AUTH_TOKEN'

curl -X 'POST' \
  'https://api.us.svix.com/api/v1/stream/event-type' \
  -H 'Authorization: Bearer AUTH_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
        "name": "user.signup",
        "description": null,
        "featureFlags": ["cool-new-feature"]
    }'

Event Type Filtering

When creating a Sink, you can optionally specify which event types the Sink should filter on.

In this example, the Google Cloud Storage sink will only receive events with the event type user.created or user.login.

If no event types are selected when creating a Sink, the Sink will receive all events, regardless of the event type.