coss.comdocs

Update an event type

PATCH
/v1/hooks/event_types/{name}

Changes its description, schema or examples, or archives or restores it.

Authorization

bearerAuth
headerAuthorizationBearer <token>

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

Path Parameters

name*string

The event type's name.

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"

Request Body

application/json
  1. body
description?|
Lengthlength <= 256
schema?|

A JSON Schema of the payload, shown to your users (not enforced).

examples?array<>

Up to 5 example payloads; the first is what a test send delivers.

Itemsitems <= 5
archived?boolean

false restores an archived type.

Response Body

The event type.

application/json
  1. response
object*"hook_event_type"
Value in"hook_event_type"
name*string
description*string|null
schema*|null
examples*array<>
archived*boolean

Archived 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*string
Formatdate-time
updated_at*string
Formatdate-time
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.update("invoice.paid", {  archived: false,});
{  "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"}