incomingEvents.arrivals

The last 20 posts and what each did (outcome; accept values you do not know), kept 30 days.

Prerequisites

  • A Curviate API key, passed as apiKey when you construct the client. Quickstart shows how to create one.

Signature

arrivals(id: string): Promise<IncomingEventArrivals>

Example

import { Curviate } from "@curviate/sdk";
 
const curviate = new Curviate({
  apiKey: "cvt_live_...",
  baseUrl: "https://api.curviate.com",
});
 
const page = await curviate.incomingEvents.arrivals("YOUR_ID");
for (const item of page.items ?? []) {
  console.log(item.contact_id);
}
// `page.cursor` is the opaque cursor for the next page (null when exhausted).

Parameters

NameTypeRequiredDescription
idstringYesIncoming event id (inc_...).

Returns

Resolves to IncomingEventArrivals. Top-level fields: object, items.

Error codes

CodeWhat it means, and what to do
UNAUTHORIZEDThe API key is missing, malformed, or revoked. Check the key you passed to the client.
INVALID_REQUESTA parameter failed validation. The message names the offending field; fix the request rather than retrying it.
RATE_LIMIT_ACCOUNTThis account's own quota is exhausted. Wait for the window in the Retry-After header, then retry.
RATE_LIMIT_TENANTThe tenant-wide quota is exhausted across all accounts. Slow the whole workload, not just this call.
PLATFORM_RATE_LIMITLinkedIn is throttling this account. Back off well beyond the hinted delay; sustained pressure risks the account.
PLATFORM_ERRORAn upstream failure, usually transient: retry once with backoff before treating it as a real error. Check the response first, though. When it carries retry_likely_to_succeed: false and retry_hint: {kind: "never"}, retrying cannot help and backing off only delays the real answer.
RESOURCE_NOT_FOUNDThe id in the path does not exist, or is not visible to this account. Re-read it from the list endpoint that produced it.
TEAM_REQUIREDSee the error codes reference.

Every code above is a stable CurviateError.code you can branch on. The full list, the response envelope, and retry semantics are in the Error codes reference.

Next steps

  • incomingEvents.list: The Team's incoming events (url masked); event keeps one event name.
  • incomingEvents.get: One incoming event, url masked; shape is the captured sample as paths and types only.
  • incomingEvents.capture: The next post replaces the sample (paths and types only) and, when switched on, still moves Enrollments.
  • SDK Quick Start: installation, the client, account scoping, and pagination.