Interface: FireEventOptions

Properties

Property	Type	Description	Defined in
<a id="property-action_label"></a> `action_label?`	`string`	Human-readable action label that appears on the envelope. Optional but encouraged — it's what the user sees in their /me/earn ledger.	me-client/src/event.ts:46
<a id="property-metadata"></a> `metadata?`	`Record`<`string`, `unknown`>	Free-form metadata stored on the envelope. Public — anyone who GETs /api/envelope/<id> sees it. Don't put secrets here.	me-client/src/event.ts:57
<a id="property-payment_amount_sats"></a> `payment_amount_sats?`	`number`	For percent_of_amount-priced subtypes, the underlying amount the fee is computed against. Required for those subtypes.	me-client/src/event.ts:49
<a id="property-project_key"></a> `project_key`	`string`	Your project_key (e.g. `pk_live_yourcompany`). Required.	me-client/src/event.ts:40
<a id="property-subtype"></a> `subtype`	`EventSubtype`	Canonical billable subtype. Class is inferred by the server.	me-client/src/event.ts:42
<a id="property-user_address"></a> `user_address?`	`string`	Override the user identity the envelope is credited to. Default is the currently-authenticated user (cookie / Bearer). Pass this only when firing on a user's behalf in a server-to-server flow — the project must have an explicit allowlist.	me-client/src/event.ts:54