coss.comdocs

Send a test message

POST
/v1/hooks/applications/{application}/endpoints/{endpoint_id}/test

Sends a message to this endpoint only (whatever its filter), with the given payload or the event type's first example. It counts against the send quota like any message.

Authorization

bearerAuth
headerAuthorizationBearer <token>

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

Path Parameters

application*string

The application's id (happ_…) or your uid for it.

endpoint_id*string

The endpoint's id.

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
event_type*string
Match^[A-Za-z0-9_.-]{1,64}$
payload?

Defaults to the event type's first example.

Response Body

The test message, queued.

application/json
  1. response
object*"hook_message"
Value in"hook_message"
id*string

Also the webhook-id header of every request delivering it.

application_id*string
event_type*string
payload*

The JSON body delivered to each endpoint.

created_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.endpoints.sendTest("customer_8812", "hep_01k7c8m4q2f3e9v6t5r1n0p8yz", {  event_type: "invoice.paid",});
{  "object": "hook_message",  "id": "hmsg_01k7c8m4q2f3e9v6t5r1n0p8yz",  "application_id": "happ_01k7c8m4q2f3e9v6t5r1n0p8yz",  "event_type": "invoice.paid",  "payload": {    "invoice_id": "in_1042",    "amount": 4200,    "currency": "usd"  },  "created_at": "2026-01-15T09:30:00.000Z"}