Skip to content
ClickFix
Sign inBook a demo
Documentation

Send an event to the company timeline

View as MarkdownOpen in ChatGPTOpen in ClaudeFeedback
POST
/v1/public-api/company-events

Scope: events:write. Adds a notable event of your product (e.g. plan upgrade, error) to the company's timeline. contact_email links the event to a known contact. A repeated idempotency_key returns the stored event with duplicate: true.

Authorization

integrationKey
headerAuthorizationBearer <cf_sk_…>

Organization API key (cf_sk_…), created under Organization → API and automations → API keys and sent as Authorization: Bearer cf_sk_….

Header Parameters

Idempotency-Key*string
Lengthlength <= 200

Request Body

application/json
  1. body
company_uuid?string
Formatuuid
external_id?string
domain?string
contact_email?string
name*string
Length1 <= length <= 100
properties?
source?string
Lengthlength <= 32
Default"api"
idempotency_key?string
Lengthlength <= 200
occurred_at?string
Formatdate-time

Response Body

OK

application/json
  1. response
success*true
Value intrue
data*
meta*
Example Request
curl -X POST 'https://api.getclickfix.com/v1/public-api/company-events' \  -H 'Idempotency-Key: string' \  -H 'Content-Type: application/json' \  -d '{  "external_id": "F-77",  "name": "seat_limit_reached",  "properties": {    "seats": 12,    "limit": 12  },  "contact_email": "ayse@example.com",  "source": "billing",  "idempotency_key": "evt-2026-11-11-f77-seats",  "occurred_at": "2026-11-11T09:31:00Z"}'
Example Response
{  "success": true,  "data": {    "uuid": "9b8a7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",    "company_uuid": "0f9e8d7c-6b5a-4493-8271-605f4e3d2c1b",    "name": "seat_limit_reached",    "properties": {      "seats": 12,      "limit": 12    },    "source": "billing",    "occurred_at": "2026-11-11T09:31:00Z",    "duplicate": true  },  "meta": {    "request_id": "01JCK9ZQ3M8R2W7X5E4T1N0PAB"  }}