Create an event

post

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

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Event data to be ingested

customerId

uuid

required

Tabs Customer ID - must be a valid UUID v4

eventTypeId

uuid

required

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

datetime

date-time

required

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

idempotencyKey

uuid

required

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

value

double

required

Numeric value of the event

differentiator

string

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

invoiceSplitKey

string

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

metadata

object

Optional metadata in JSON format

Responses

200Event created successfully

400Bad request - Invalid event data or duplicate idempotency key

401Unauthorized - Invalid or missing API key

422Unprocessable Entity - Validation errors

429Too Many Requests - Rate limit exceeded

500Internal Server Error