Events › Report events in bulk

Events

Report events in bulk

POST/api/{ORG}/eventsPermalink

Up to 100 events: each row { name, link?, click?, … } as one event's body, the link and click named in the row. Each row is recorded or refused by itself, and the answer lists each in order: { status, event?, error? } (201 recorded, 200 a repeat, else the refusal's status and its envelope). Send an id with each so a retry records nothing twice.

Permission
Integrations · create
Plan
Plans that include the API: Pricing
Retry
Safe with an Idempotency-Key

Example request

bash
curl -X POST "https://console.brevily.com/api/NORTHWIND/events" \  -H "x-api-key: brv_ak_7Fq2Lw9xK3" \  -H "x-api-secret: $BREVILY_SECRET" \  -H "Idempotency-Key: 4f9c1e2a-autumn" \  -H "Content-Type: application/json" \  -d '[    {      "name": "example",      "link": "example",      "click": "example",      "customer": "example",      "amount": 1,      "currency": "example",      "id": "01JC6Y8QH2M4ZK7T9VRW3XNB5D",      "occurredAt": "2026-11-05T09:41:00Z",      "properties": "example"    }  ]'

Example answer

json
[  {    "status": 1,    "event": "example",    "error": "example"  }]

Made-up values. Send your own Idempotency-Key, one per change.

PathPermalink

Path parameters
NameTypeRequiredDescriptionAllowed values
ORGstringrequiredYour organisation’s code.3 to 20 characters

BodyPermalink

JSON. An unknown field is refused with a 400 naming it.

Body fields
NameTypeRequiredDescriptionAllowed values
namestringrequiredThe event’s name: sale, install, lead or your own.—
linkstringoptionalThe link it is against.—
clickstringoptionalThe click it is bound to (the id in brv_click), with its link.—
customerstringoptionalYour id for the person.—
amountintegeroptionalThe amount in minor units; needs currency.—
currencystringoptionalThe amount’s ISO 4217 currency.—
idstringoptionalYour own id for it; a repeat is recorded once.—
occurredAtdate-timeoptionalWhen it happened, ISO 8601.—
propertiesanyoptionalIts properties, as for one event.—

AnswerPermalink

A list of EventOutcome, one page at a time: paging.

Answer fields
NameTypeDescriptionAllowed values
statusinteger201 recorded, 200 a repeat, else the refusal’s status.—
eventanyThe event recorded, as a single report answers it.—
erroranyThe refusal: its code, message and details.—

ErrorsPermalink

Errors
Status Code When
400 VALIDATION_FAILED A field, a parameter or the body is wrong; details.fields says which.
400 IDEMPOTENCY_KEY_INVALID The Idempotency-Key is longer than 255 characters.
401 UNAUTHENTICATED No key, a key that does not match, or one expired or revoked.
403 ACCESS_DENIED The key lacks Integrations · create, or the organisation’s plan does not include it.
404 NOT_FOUND No organisation with that code for this key, or no such record in it.
409 CONFLICT
409 IDEMPOTENCY_IN_FLIGHT The first call with this Idempotency-Key is still running.
413 PAYLOAD_TOO_LARGE
415 UNSUPPORTED_MEDIA
422 IDEMPOTENCY_MISMATCH The same Idempotency-Key was sent with a different request.
429 RATE_LIMITED Too many calls: wait Retry-After seconds.

Rate limitsPermalink

Counted with every other call of the organisation, by plan: Pricing. The answer carries RateLimit-Limit, RateLimit-Remaining and RateLimit-Reset; more on rate limits.