Retrieve an event type
An event type of the API key's environment, archived or not.
bearerAuthAuthorizationBearer <token>A secret API key from the dashboard: coss_live_… for production environments, coss_test_… for sandbox environments.
name*stringThe event type's name.
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.
"2026-10-10"The event type.
application/json- response
- response
- …
object*"hook_event_type""hook_event_type"name*stringThe type's name, which messages send as event_type.
description*|What this event means, shown to your users. null: none.
schema*|A JSON Schema of the payload, shown to your users (not enforced). null: none.
examples*array<>Sample payloads, shown to your users. Test sends use the first.
archived*booleanArchived types are hidden from the portal and can't be subscribed to; messages of the type are still delivered to endpoints that subscribed before.
created_at*stringdate-timeupdated_at*stringdate-timeimport { 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.get("invoice.paid");{ "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"}