Take an event feed checkpoint

GET

/integration/v1/organizations/{organization}/events/checkpoint

curl --request GET \
  --url https://api.elwids.xyz/api/integration/v1/organizations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/events/checkpoint \
  --header 'Authorization: Bearer <token>'

Requires: events:read, plus one of alerts:read or geofences:read

Rate limits: 240 a minute per address, 60 a minute per application

A cursor at the current head of the organization’s event journal. Take it before reading current state (for example every alert page), then read the feed from it. Needs events:read and either alerts:read or geofences:read, each on both the application and the token.

Authorizations

• applicationToken

Parameters

Path Parameters

organization

required

string format: uuid

The organization UUID. A value that does not match returns 404.

Responses

200

A cursor at the head of the journal.

Media typeapplication/json

object

cursor

required

string

>= 1 characters

Example

{
  "cursor": "eyJpdiI6IlZ3dE1oUnRkWjBTeUtmZz09IiwidmFsdWUiOiJjdXJzb3IifQ=="
}

Headers

Cache-Control

required

string

/(^|[ ,])no-store([ ,]|$)/

Responses to authenticated integration requests are never cached. The header also carries private.

Example

no-store, private

401

No valid credentials: no session (first-party API), or a missing, invalid, expired or revoked application token (integration API).

Media typeapplication/json

The body of most error responses.

object

message

required

string

Example ^generated

{
  "message": "example"
}

403

The caller is not allowed: not a member of the organization, missing a tenant or platform permission, or (integration API) an ability not granted on both the application and the token.

Media typeapplication/json

The body of most error responses.

object

message

required

string

Example ^generated

{
  "message": "example"
}

404

Not found: an unknown organization or resource, a resource in another organization or not granted to the application, or a malformed identifier (the route does not match).

Media typeapplication/json

The body of most error responses.

object

message

required

string

Example ^generated

{
  "message": "example"
}

429

A rate limit was reached; see x-rate-limits on the operation.

Media typeapplication/json

The body of most error responses.

object

message

required

string

Example ^generated

{
  "message": "example"
}

Headers

Retry-After

required

integer

Seconds to wait before retrying.