Skip to main content
POST
/
signals
Create a signal
curl --request POST \
  --url https://app.gaintrace.com/api/v1/signals \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": "<string>",
  "description": "<string>",
  "metadata": {}
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer API key. Secret server keys start with gt_live_; client-safe browser keys start with gt_pub_ (write-only, origin-pinned). Create and scope keys in Settings → API Keys.

Body

application/json
​
accountId
string<uuid>
required

Must belong to your workspace.

​
type
enum<string>
required
Available options:
usage_drop,
usage_spike,
feature_adoption,
support_ticket,
payment_failed,
expansion_signal,
nps_response,
contract_renewal,
login_inactive,
champion_left
​
severity
enum<string>
required
Available options:
info,
warning,
critical
​
title
string
required
Required string length: 1 - 500
​
description
string | null
Maximum string length: 5000
​
metadata
object | null

Arbitrary JSON, max 10KB serialized.

Response

Signal created.

​
data
object
Last modified on July 6, 2026