Synchronously ingest billable events

POST

/v1/events/ingest

POST

/v1/events/ingest

1 import { AfternoonClient } from "grant-sdk";
2 
3 async function main() {
4     const client = new AfternoonClient({
5         token: "YOUR_TOKEN_HERE",
6     });
7     await client.events.ingest({
8         eventName: "api.request",
9         idempotencyKey: "evt_abc123xyz",
10         customerId: "cjld2cjxh0000qzrmn831i7rn",
11         timestamp: new Date("2023-11-07T05:31:56Z"),
12     });
13 }
14 main();

1 {
2   "success": true,
3   "status": "inserted",
4   "request_id": "req_abc123",
5   "usage_id": "cm5x9z8nv0000h85r7l9p2k1m",
6   "cost": [
7     {
8       "amount": "120",
9       "account_type": "pricing_unit",
10       "pricing_unit_code": "api_call",
11       "currency_code": "usd"
12     }
13   ],
14   "customer_balances": [
15     {
16       "balance": "980",
17       "account_type": "pricing_unit",
18       "pricing_unit_code": "api_call",
19       "currency_code": "usd"
20     }
21   ],
22   "error": {
23     "code": "DATABASE_ERROR",
24     "message": "Failed to insert event"
25   }
26 }

Accepts a single billable event and inserts it synchronously into the database.

Authentication

AuthorizationBearer

API key obtained from the Grant dashboard

Request

This endpoint expects an object.

event_namestringRequired1-255 characters

Name of the event

idempotency_keystringRequired1-255 characters

Unique key to prevent duplicate event processing

customer_idstringRequiredformat: "cuid"

Customer identifier

timestampdatetimeRequired

Event timestamp in ISO 8601 UTC format (Z or +00:00)

session_idstringOptional1-255 characters

Optional session identifier. When provided, it is persisted on the billable event and associated product usage events to group related events.

propertiesmap from strings to anyOptional

Additional event properties

Response

Events processed synchronously

successboolean

statusenum

Processing outcome for the submitted event

request_idstring

Request ID for tracing

usage_idstringOptional

Created or existing billable event ID

costlist of objectsOptional

Aggregated event cost by wallet denomination. Present on successful requests.

customer_balanceslist of objectsOptional

Current customer wallet balances across denominations after ingestion.

errorobjectOptional

Errors

400

Bad Request Error

401

Unauthorized Error

413

Content Too Large Error

429

Too Many Requests Error

500

Internal Server Error