Seat Events

Create a seat event

Changed on

Create a new seat event. Seat events are used for calculating charges.

post/seat-events

Request

  • Base URL
    https://sandbox.sequencehq.com/api
  • URL
    https://sandbox.sequencehq.com/api/seat-events
  • Auth
    none declared. Required headers: Authorization

Headers

Authorizationstring required

Your API credentials. Eg. Basic {credentials}.

Sequence-Version'2024-07-30'

Use this header to select an API version

Request body

customerEventIdstring nullable

Unique ID provided by customer. Another event with the same customer event ID will supersede this one.

customerAliasstring required

End-customer alias or ID.

seatTypestring required

Seat type. This can be referenced from a seat metric.

eventTimestampstring required

Event timestamp, in ISO 8601 format.

totalinteger required

Total seats consumed for this seat type.

Example request

{
  "customerEventId": "event-id-H4twuTWpYx1rkd8OMTki2hTUcZ",
  "customerAlias": "customer-id-2H4u5BBwBWsS5V2sroRFqJfTXpW",
  "seatType": "admin",
  "eventTimestamp": "2022-10-01T00:00:00Z",
  "total": 1
}

Response

Created

idstring required

Unique ID for this seat event.

customerEventIdstring required

Unique ID provided by customer. Another event with the same customer event ID will supersede this one.

customerAliasstring required

End-customer alias or ID.

seatTypestring required

Seat type. This can be referenced from a seat metric.

sequenceAccountIdstring required

Unique Sequence account ID.

eventTimestampstring required

Event timestamp, in ISO 8601 format.

totalinteger required

Total seats consumed for this seat type.

Example response

{
  "id": "0184421a-8202-70ea-a729-30308a40bbf7",
  "customerEventId": "event-id-H4twuTWpYx1rkd8OMTki2hTUcZ",
  "customerAlias": "customer-id-2H4u5BBwBWsS5V2sroRFqJfTXpW",
  "seatType": "admin",
  "sequenceAccountId": "0184421e-a9cc-711b-af93-bf0511d4d833",
  "eventTimestamp": "2022-10-01T00:00:00Z",
  "total": 1
}

Changes