Skip to main content
POST
/
usage-events
Create a new Usage Event
curl --request POST \
  --url https://dev.seqhq.io/api/usage-events \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customerEventId": "event-id-H4twuTWpYx1rkd8OMTki2hTUcZ",
  "customerAlias": "customer-id-2H4u5BBwBWsS5V2sroRFqJfTXpW",
  "eventType": "message-sent",
  "eventTimestamp": "2022-10-01T00:00:00Z",
  "eventProperties": {
    "length": 500,
    "type": "text_message"
  }
}
'
{
  "id": "0184421a-8202-70ea-a729-30308a40bbf7",
  "customerEventId": "event-id-H4twuTWpYx1rkd8OMTki2hTUcZ",
  "customerAlias": "customer-id-2H4u5BBwBWsS5V2sroRFqJfTXpW",
  "eventType": "message-sent",
  "sequenceAccountId": "0184421e-a9cc-711b-af93-bf0511d4d833",
  "eventTimestamp": "2022-10-01T00:00:00Z",
  "eventProperties": {
    "length": 500,
    "type": "text_message"
  }
}

Headers

​
Authorization
string
required

Your API credentials. Eg. Basic {credentials}.

​
Sequence-Version
enum<string>

Use this header to select an API version

Available options:
2024-07-30

Body

application/json
​
customerAlias
string
required

End-customer alias or ID

Example:

"customer-id-2H4u5BBwBWsS5V2sroRFqJfTXpW"

​
eventType
string
required

Event type. This can be referenced from a usage metric.

Example:

"message-sent"

​
customerEventId
string

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

Example:

"event-id-H4twuTWpYx1rkd8OMTki2hTUcZ"

​
eventTimestamp
string

Event timestamp, in ISO 8601 format.

Example:

"2022-10-01T00:00:00Z"

​
eventProperties
object

Event properties. These can be referenced by a usage metric.

Response

Created

​
id
string
required

Unique ID

Example:

"0184421a-8202-70ea-a729-30308a40bbf7"

​
customerEventId
string
required

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

Example:

"event-id-H4twuTWpYx1rkd8OMTki2hTUcZ"

​
customerAlias
string
required

End-customer alias or ID

Example:

"customer-id-2H4u5BBwBWsS5V2sroRFqJfTXpW"

​
eventType
string
required

Event type. This can be referenced from a usage metric.

Example:

"message-sent"

​
sequenceAccountId
string
required

Sequence account ID

Example:

"0184421e-a9cc-711b-af93-bf0511d4d833"

​
eventTimestamp
string
required

Event timestamp, in ISO 8601 format.

Example:

"2022-10-01T00:00:00Z"

​
eventProperties
object
required

Event properties. These can be referenced by a usage metric.