VoidhashDocs
DocumentationAPI reference
Dashboard
Essentials
API overview
Authentication
Endpoints
Analytics
Api_keys
Auth
Component_dev_sessions
Component_registry
Components
Development
Events
Experiments
Feature_flag_overrides
Feature_flag_targets
Feature_flags
Ingest_policy
Notification_sends
Notifications
Organizations
Payment_provider_configurations
Payment_provider_products
Paywall_locations
Paywalls
Perks
Persons
Products
Projects
Push_notification_configurations
Schema
Sdk
Users
Webhooks
Analytics
Event capture
Event_capture
Capture
Batch

Capture

POST
/i/v1/capture

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

uuid*string
Length1 <= length
event*string
Length1 <= length
context*
properties*
distinct_id*string
Length1 <= length
session_id?|null
timestamp?string|null
sent_at*string
token*string
Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/i/v1/capture" \  -H "Content-Type: application/json" \  -d '{    "uuid": "string",    "event": "string",    "context": {      "property1": "string",      "property2": "string"    },    "properties": {      "property1": "string",      "property2": "string"    },    "distinct_id": "string",    "sent_at": "string",    "token": "string"  }'
{  "accepted": 0,  "rejected": 0}
{  "_tag": "CaptureInvalidRequestError",  "error": "string",  "code": "invalid_request"}
{  "_tag": "CaptureUnauthorizedError",  "error": "string",  "code": "unauthorized"}
{  "_tag": "CapturePayloadTooLargeError",  "error": "string",  "code": "payload_too_large"}
{  "_tag": "CaptureRateLimitedError",  "error": "string",  "code": "rate_limited",  "retry_after_ms": 0}
{  "_tag": "CaptureInternalServerError",  "error": "string",  "code": "internal_error"}
{  "_tag": "CaptureDependencyUnavailableError",  "error": "string",  "code": "dependency_unavailable"}
PreviousRetry Webhook DeliveryNextBatch