coss.comdocs

List event types

GET
/v1/hooks/event_types

The environment's event types by name; archived ones only with include_archived.

Authorization

bearerAuth
headerAuthorizationBearer <token>

A secret API key from the dashboard: coss_live_… for production environments, coss_test_… for sandbox environments.

Query Parameters

include_archived?string

Also list archived types (default false).

Value in"true""false"
limit?integer

1-100, default 50.

Range1 <= value <= 100
after?string

Cursor: the name of the last type of the previous page.

Header Parameters

Coss-Version?"2026-10-10"

The API version (a date) to use for this request. Defaults to your organization's version, pinned to the latest one when it first used the API and upgraded from the dashboard. The SDK always sends the version it was built for.

Value in"2026-10-10"

Response Body

A page of event types.

application/json
  1. response
object*"list"
Value in"list"
data*array<>
has_more*boolean
import { Coss } from "coss";const coss = new Coss({  apiKey: process.env.COSS_API_KEY,  baseUrl: "https://api.coss.com",});const { data, error } = await coss.hooks.eventTypes.list();
{  "object": "list",  "data": [    {      "object": "hook_event_type",      "name": "invoice.paid",      "description": "An invoice was paid in full.",      "schema": {        "type": "object",        "properties": {          "invoice_id": {            "type": "string"          },          "amount": {            "type": "integer"          }        }      },      "examples": [        {          "invoice_id": "in_1042",          "amount": 4200,          "currency": "usd"        }      ],      "archived": false,      "created_at": "2026-01-15T09:30:00.000Z",      "updated_at": "2026-01-15T09:30:00.000Z"    }  ],  "has_more": false}