Ingest Events

Ingest batch of events.

Scopes: events:write

POST /v1/events/ingest

PHP (SDK)

PHP

declare(strict_types=1);

require 'vendor/autoload.php';

use Spaire;
use Spaire\Models\Components;

$sdk = Spaire\Spaire::builder()
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->build();

$request = new Components\EventsIngest(
    events: [],
);

$response = $sdk->events->ingest(
    request: $request
);

if ($response->eventsIngestResponse !== null) {
    // handle response
}

200

{
  "inserted": 123,
  "duplicates": 0
}

Authorizations

Authorization · string · header · required

You can generate an Organization Access Token from your organization's settings.

Body

application/json

events · (EventCreateCustomer · object | EventCreateExternalCustomer · object)[] · required

List of events to ingest.

EventCreateCustomer

EventCreateExternalCustomer

Show child attributes

Response

200

application/json

Successful Response

inserted · integer · required

Number of events inserted.

duplicates · integer · default: 0

Number of duplicate events skipped.