events

Create an event

Creates a new usage event. Requires valid authentication and unique idempotency key.

post/v1/events

Request

  • Base URL: https://integrators.prod.api.tabsplatform.com
  • URL: https://integrators.prod.api.tabsplatform.com/v1/events
  • Auth: API key in header Authorization

Request body

customerIdstring uuid required

Tabs Customer ID - must be a valid UUID v4

eventTypeIdstring uuid required

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

datetimestring date-time required

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

idempotencyKeystring uuid required

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

valuenumber double required

Numeric value of the event

differentiatorstring

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

invoiceSplitKeystring

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

metadataobject

Optional metadata in JSON format

Response

Event created successfully

successboolean

Indicates if the operation was successful

messagestring

Human-readable message about the operation result

Changes

No recorded changes to this operation across all 1 revision of this API.