Create an event

POST

https://usage-events.prod.api.tabsplatform.com/v1/events

POST

/v1/events

$ curl -X POST https://usage-events.prod.api.tabsplatform.com/v1/events \
>      -H "Authorization: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "customerId": "550e8400-e29b-41d4-a716-446655440000",
>   "eventTypeId": "550e8400-e29b-41d4-a716-446655440000",
>   "datetime": "2024-01-15T10:30:00Z",
>   "idempotencyKey": "550e8400-e29b-41d4-a716-446655440000",
>   "value": 1.5
> }'

1 {
2   "success": true,
3   "message": "Event created successfully",
4   "data": {
5     "events": {
6       "customerId": "550e8400-e29b-41d4-a716-446655440000",
7       "eventTypeId": "550e8400-e29b-41d4-a716-446655440000",
8       "datetime": "2024-01-15T10:30:00Z",
9       "idempotencyKey": "018c1234-5678-7abc-def0-123456789abc",
10       "value": 1,
11       "differentiator": "mobile",
12       "invoiceSplitKey": "invoice-123",
13       "manufacturerId": "550e8400-e29b-41d4-a716-446655440000"
14     }
15   }
16 }

Creates a new usage event. Requires valid authentication and unique idempotency key. Reach out to your account manager if you would like to participate in the Beta for the new Usage API.

Authentication

Authorizationstring

API Key authentication via header

Request

This endpoint expects an object.

customerIdstringRequiredformat: "uuid"

Tabs Customer ID - must be a valid UUID v4

eventTypeIdstringRequiredformat: "uuid"

Type of event being recorded - must be a valid UUID v4

datetimedatetimeRequired

Timestamp when the event occurred (UTC) (format: ISO-8601 datetime string)

idempotencyKeystringRequiredformat: "uuid"

Unique key to prevent duplicate event processing - must be a valid UUID v4

valuedoubleRequired

Numeric value of the event

differentiatorstringOptional

Optional key to separate events with the same event type and customer into different invoice line items; differentiator will be appended to the description of the new invoice line item

invoiceSplitKeystringOptional

Optional key to split events into a new invoice; the split key will be appended to the new invoice number

metadatamap from strings to objectsOptional

Optional metadata in JSON format

Response

Event created successfully

successbooleanOptional

Indicates if the operation was successful

messagestringOptional

Human-readable message about the operation result

dataobjectOptional

Event data wrapper

Errors

400

Bad Request Error

401

Unauthorized Error

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error