coss.comdocs

Create an application

POST
/v1/hooks/applications

Creates an application: one of your customers (or users), who gets their own endpoints and portal. Give it a uid (e.g. your customer's id) to address it by in every path. Hooks resources belong to the API key's own environment: a coss_test_… key only ever sees sandbox ones, a coss_live_… key only production ones.

Authorization

bearerAuth
headerAuthorizationBearer <token>

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

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
name*string

Shown to the application's users in the portal.

Length1 <= length <= 256
uid?string

Your own id for it, to address it by in every path instead of its id.

Match^[A-Za-z0-9_.:@|-]{1,256}$
metadata?

Your own key-value pairs (at most 16; keys up to 40 characters, values up to 500).

Response Body

The application.

application/json
  1. response
object*"hook_application"
Value in"hook_application"
id*string
uid*|

Your own id for it (e.g. your customer's id), unique in the environment. Every path that takes an application accepts its id or its uid.

name*string
metadata*
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.applications.create({  name: "Acme Corp",  uid: "customer_8812",  metadata: {    plan: "pro",  },});
{  "object": "hook_application",  "id": "happ_01k7c8m4q2f3e9v6t5r1n0p8yz",  "uid": "customer_8812",  "name": "Acme Corp",  "metadata": {    "plan": "pro"  },  "created_at": "2026-01-15T09:30:00.000Z",  "updated_at": "2026-01-15T09:30:00.000Z"}