POST
/
v1
/
events
/
batch
curl --request POST \
  --url https://ingest.hyperline.co/v1/events/batch \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '[
  {
    "customer_id": "cus_QalW2vTAdkR6IY",
    "event_type": "api_call",
    "timestamp": "2023-01-20T16:04:11Z",
    "record": {
      "id": "D32NAA8",
      "durationInMs": 32,
      "isVerified": true
    }
  }
]'
{
  "events_created": [
    {
      "customer_id": "cus_QalW2vTAdkR6IY",
      "event_type": "api_call",
      "timestamp": "2023-01-20T16:04:11Z",
      "record": {
        "id": "D32NAA8",
        "durationInMs": 32,
        "isVerified": true
      }
    }
  ],
  "events_failed": [
    {
      "customer_id": "cus_QalW2vTAdkR6IY",
      "event_type": "api_call",
      "timestamp": "2023-01-20T16:04:11Z",
      "record": {
        "id": "D32NAA8",
        "durationInMs": 32,
        "isVerified": true
      }
    }
  ]
}

Authorizations

Authorization
string
headerrequired

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json · object[]
customer_id
string
required

Hyperline ID or external ID of the existing customer.

event_type
string
required

Type corresponding to the event. When creating a dynamic product, this type will be used to map the related events to specific prices.

timestamp
string
required

UTC date time string in the ISO 8601 format, or milliseconds since the epoch. The event timestamp is used to retrieve the events related to a specific billing period.

record
object
required

Payload of the event containing an ID and any additional metadata.

Response

201 - application/json
events_created
object[]
required
events_failed
object[]
required