Event Types

Each message sent through Svix has an associated event type. Event types are identifiers denoting the type of the message being sent.

Event types are just string, and can be anything. For example: user.signup, invoice.paid and workflow.completed.

Event types are primarily used to decide which events are sent to which endpoint. By default, all messages are sent to all endpoints. Though when adding or editing endpoints, users can choose to only subscribe to some of the event types for this particular endpoint.

Bulk Create

It's recommended to add the event types you are going to use ahead of time. You can do it using the scripts in the bulk creating event types section.

This is how choosing event types look like in the pre-built application portal:

Using event types

You can add, edit, and delete event types in the dashboard or through the API below.

JavaScript

import { Svix } from "svix";
const svix = new Svix("AUTH_TOKEN");const eventType = await svix.eventType.create({  name: "user.signup",  description: "A user has signed up",});

Python

from svix.api import Svix, EventTypeIn
svix = Svix("AUTH_TOKEN")app = svix.application.create(EventTypeIn(    name="user.signup",    description="A user has signed up"))

Go

import (    svix "github.com/svix/svix-libs/go")
svixClient := svix.New("AUTH_TOKEN", nil)app, err := svixClient.EventType.Create(&svix.EventTypeIn{    Name: "user.signup",    Description: "A user has signed up",})}

Java

import com.svix.Svix;import com.svix.models.EventTypeIn;

Svix svix = new Svix("AUTH_TOKEN");svix.getEventType()  .create(new EventTypeIn()    .name("user.signup")    .description("A user has signed up")  );

CLI

export SVIX_AUTH_TOKEN='AUTH_TOKEN'svix event-type create '{ "name": "user.signup", "description": "A user has signed up" }'

cURL

export SVIX_AUTH_TOKEN='AUTH_TOKEN'
curl -X POST "https://api.svix.com/api/v1/event-type/" \    -H  "Accept: application/json" \    -H  "Content-Type: application/json" \    -H  "Authorization: Bearer ${SVIX_AUTH_TOKEN}" \    -d '{ "name": "user.signup", "description": "A user has signed up" }'

Bulk creating event types

The easiest way to bulk-create event types is by just writing a simple script to load a pipe delimited CSV file or a JSON file with the event types and make the API requests.

Here is an example CSV file (without headers) of events:

user.created|A user has been createduser.removed|A user has been removeduser.changed|A user has changed

Here are some example scripts for processing the above file:

JavaScript

import { Svix } from "svix";import fs from "fs";import readline from "readline";
const svix = new Svix("AUTH_TOKEN");
async function execute() {  const fileStream = fs.createReadStream("./data.csv");
  const data = readline.createInterface({    input: fileStream,    crlfDelay: Infinity,  });
  for await (const lineItr of data) {    const line = lineItr.split("|");    const eventType = await svix.eventType.create({      name: line[0],      description: line[1],    });  }}
execute();

Python

import jsonfrom svix.api import Svix, EventTypeIn
svix = Svix("AUTH_TOKEN")
with open("./data.csv", "r") as f:    for line in f:        name, description = line.split("|")        app = svix.event_type.create(EventTypeIn(            name=name,            description=description,        ))

Go

package main
import (    "bufio"    "log"    "os"    "strings"
    svix "github.com/svix/svix-libs/go")
func main() {    svixClient := svix.New("AUTH_TOKEN", nil)
    f, err := os.Open("./data.csv")    if err != nil {        log.Fatal(err)    }    defer f.Close()
    scanner := bufio.NewScanner(f)    for scanner.Scan() {        line := strings.Split(scanner.Text(), "|")        _, err = svixClient.EventType.Create(&svix.EventTypeIn{            Name:        line[0],            Description: line[1],        })        if err != nil {            log.Println(err)        }    }    if err := scanner.Err(); err != nil {        log.Fatal(err)    }}

Java

package sviximport;
import java.io.FileReader;import java.io.IOException;import java.util.Scanner;import com.svix.Svix;import com.svix.models.EventTypeIn;import com.svix.exceptions.ApiException;
public class App {
    public static void main(String[] args) {        Svix svix = new Svix("AUTH_TOKEN");
        try (Scanner scanner = new Scanner(new FileReader("/Users/fcjr/Desktop/import/data.csv"));) {            while (scanner.hasNextLine()) {                try {                    String[] line = scanner.nextLine().split("|");                    svix.getEventType().create(new EventTypeIn().name(line[0]).description(line[1]));                } catch(ApiException e) {                    if (e.getCode() != 409) {                        System.out.println(e.getResponseBody());                        System.exit(1);                    }                }            }        } catch(IOException e) {            System.out.println(e.toString());            System.exit(1);        }    }}

CLI

export SVIX_AUTH_TOKEN='AUTH_TOKEN'
while IFS=$'|', read -r name descriptiondo    svix event-type create "{ \"name\": \"${name}\", \"description\": \"${description}\" }"done < data.csv

cURL

export SVIX_AUTH_TOKEN='AUTH_TOKEN'
while IFS=$'|', read -r name descriptiondo    curl -X POST "https://api.svix.com/api/v1/event-type/" \        -H  "Accept: application/json" \        -H  "Content-Type: application/json" \        -H  "Authorization: Bearer ${SVIX_AUTH_TOKEN}" \        -d  "{ \"name\": \"${name}\", \"description\": \"${description}\" }"done < data.csv