Skip to content

typescript

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

typescript

README.md

@cvent/sdk

Developer-friendly & type-safe Typescript SDK specifically catered to leverage @cvent/sdk API.

Summary

Cvent REST APIs: Official Cvent SDK providing typed access to Cvent REST APIs for event management, contacts, attendees, and more using OAuth2 authentication. For documentation, see the README and USAGE. To get credentials, visit https://developers.cvent.com/docs/rest-api/overview.

For more information about the API: Cvent Developer Documentation

Table of Contents

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add @cvent/sdk

PNPM

pnpm add @cvent/sdk

Bun

bun add @cvent/sdk

Yarn

yarn add @cvent/sdk

Note

This package is published with CommonJS and ES Modules (ESM) support.

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { CventSDK } from "@cvent/sdk";

const cventSDK = new CventSDK({
  security: {
    oAuth2ClientCredentials: {
      clientID: process.env["CVENTSDK_CLIENT_ID"] ?? "",
      clientSecret: process.env["CVENTSDK_CLIENT_SECRET"] ?? "",
      tokenURL: process.env["CVENTSDK_TOKEN_URL"] ?? "",
      scopes: process.env["CVENTSDK_SCOPES"] ?? "",
    },
  },
});

async function run() {
  const result = await cventSDK.users.getAccountUserGroups({
    token: "1a2b3c4d5e6f7g8h9i10j11k",
    filter: "name eq 'My User Group'",
  });

  for await (const page of result) {
    console.log(page);
  }
}

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security schemes globally:

Name Type Scheme Environment Variable
oAuth2ClientCredentials oauth2 OAuth2 token CVENTSDK_O_AUTH2_CLIENT_CREDENTIALS
oAuth2AuthorizationCode oauth2 OAuth2 token CVENTSDK_O_AUTH2_AUTHORIZATION_CODE

You can set the security parameters through the security optional parameter when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:

import { CventSDK } from "@cvent/sdk";

const cventSDK = new CventSDK({
  security: {
    oAuth2ClientCredentials: {
      clientID: process.env["CVENTSDK_CLIENT_ID"] ?? "",
      clientSecret: process.env["CVENTSDK_CLIENT_SECRET"] ?? "",
      tokenURL: process.env["CVENTSDK_TOKEN_URL"] ?? "",
      scopes: process.env["CVENTSDK_SCOPES"] ?? "",
    },
  },
});

async function run() {
  const result = await cventSDK.users.getAccountUserGroups({
    token: "1a2b3c4d5e6f7g8h9i10j11k",
    filter: "name eq 'My User Group'",
  });

  for await (const page of result) {
    console.log(page);
  }
}

run();

Per-Operation Security Schemes

Some operations in this SDK require the security scheme to be specified at the request level. For example:

import { CventSDK } from "@cvent/sdk";

const cventSDK = new CventSDK();

async function run() {
  const result = await cventSDK.authentication.oauth2Token({
    username: "",
    password: "",
  }, {
    grantType: "client_credentials",
    clientId: "djc98u3jiedmi283eu928",
    scope: "event/events:read event/attendees:read",
    redirectUri: "https://example.com/redirect",
    refreshToken: "dn43ud8uj32nk2je",
    code: "AUTHORIZATION_CODE",
  });

  console.log(result);
}

run();

Available Resources and Operations

Available methods

Appointments

AttendeeActivities

AttendeeInsights

AttendeeMessages

Attendees

AudienceSegments

Authentication

BadgePrintJob

BadgePrinterPools

Budget

Bulk

Campaigns

CardTokens

Compliance

Contacts

CustomFields

Discounts

Emails

EventCredits

EventFeatures

EventRole

EventTravel

Events

EventsPlusHub

Exhibitor

ExhibitorContent

ExhibitorTeam

File

Hooks

Housing

HousingHotels

Leads

MeetingRequest

ProcessForm

ProposalDraft

RFPAdditionalDetails

RFPManagement

RFPRequirements

RFPSuppliers

Seating

Sessions

Signatures

Speakers

Surveys

TravelAccounts

TravelRFPs

TravelSuppliers

Usage

UserSCIM

Users

Video

Webcasts

Standalone functions

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

Available standalone functions

Pagination

Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the returned response object will also be an async iterable that can be consumed using the for await...of syntax.

Here's an example of one such pagination call:

import { CventSDK } from "@cvent/sdk";

const cventSDK = new CventSDK({
  security: {
    oAuth2ClientCredentials: {
      clientID: process.env["CVENTSDK_CLIENT_ID"] ?? "",
      clientSecret: process.env["CVENTSDK_CLIENT_SECRET"] ?? "",
      tokenURL: process.env["CVENTSDK_TOKEN_URL"] ?? "",
      scopes: process.env["CVENTSDK_SCOPES"] ?? "",
    },
  },
});

async function run() {
  const result = await cventSDK.users.getAccountUserGroups({
    token: "1a2b3c4d5e6f7g8h9i10j11k",
    filter: "name eq 'My User Group'",
  });

  for await (const page of result) {
    console.log(page);
  }
}

run();

File uploads

Certain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.

Tip

Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:

  • Node.js v20+: Since v20, Node.js comes with a native openAsBlob function in node:fs.
  • Bun: The native Bun.file function produces a file handle that can be used for streaming file uploads.
  • Browsers: All supported browsers return an instance to a File when reading the value from an <input type="file"> element.
  • Node.js v18: A file stream can be created using the fileFrom helper from fetch-blob/from.js.
import { CventSDK } from "@cvent/sdk";
import { openAsBlob } from "node:fs";

const cventSDK = new CventSDK({
  security: {
    oAuth2ClientCredentials: {
      clientID: process.env["CVENTSDK_CLIENT_ID"] ?? "",
      clientSecret: process.env["CVENTSDK_CLIENT_SECRET"] ?? "",
      tokenURL: process.env["CVENTSDK_TOKEN_URL"] ?? "",
      scopes: process.env["CVENTSDK_SCOPES"] ?? "",
    },
  },
});

async function run() {
  const result = await cventSDK.file.uploadFile({
    file: await openAsBlob("example.file"),
  });

  console.log(result);
}

run();

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:

import { CventSDK } from "@cvent/sdk";

const cventSDK = new CventSDK({
  security: {
    oAuth2ClientCredentials: {
      clientID: process.env["CVENTSDK_CLIENT_ID"] ?? "",
      clientSecret: process.env["CVENTSDK_CLIENT_SECRET"] ?? "",
      tokenURL: process.env["CVENTSDK_TOKEN_URL"] ?? "",
      scopes: process.env["CVENTSDK_SCOPES"] ?? "",
    },
  },
});

async function run() {
  const result = await cventSDK.users.getAccountUserGroups({
    token: "1a2b3c4d5e6f7g8h9i10j11k",
    filter: "name eq 'My User Group'",
  }, {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  for await (const page of result) {
    console.log(page);
  }
}

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

import { CventSDK } from "@cvent/sdk";

const cventSDK = new CventSDK({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  security: {
    oAuth2ClientCredentials: {
      clientID: process.env["CVENTSDK_CLIENT_ID"] ?? "",
      clientSecret: process.env["CVENTSDK_CLIENT_SECRET"] ?? "",
      tokenURL: process.env["CVENTSDK_TOKEN_URL"] ?? "",
      scopes: process.env["CVENTSDK_SCOPES"] ?? "",
    },
  },
});

async function run() {
  const result = await cventSDK.users.getAccountUserGroups({
    token: "1a2b3c4d5e6f7g8h9i10j11k",
    filter: "name eq 'My User Group'",
  });

  for await (const page of result) {
    console.log(page);
  }
}

run();

Error Handling

CventSDKError is the base class for all HTTP error responses. It has the following properties:

Property Type Description
error.message string Error message
error.statusCode number HTTP response status code eg 404
error.headers Headers HTTP response headers
error.body string HTTP body. Can be empty string if no body is returned.
error.rawResponse Response Raw HTTP response
error.data$ Optional. Some errors may contain structured data. See Error Classes.

Example

import { CventSDK } from "@cvent/sdk";
import * as errors from "@cvent/sdk/models/errors";

const cventSDK = new CventSDK({
  security: {
    oAuth2ClientCredentials: {
      clientID: process.env["CVENTSDK_CLIENT_ID"] ?? "",
      clientSecret: process.env["CVENTSDK_CLIENT_SECRET"] ?? "",
      tokenURL: process.env["CVENTSDK_TOKEN_URL"] ?? "",
      scopes: process.env["CVENTSDK_SCOPES"] ?? "",
    },
  },
});

async function run() {
  try {
    const result = await cventSDK.users.getAccountUserGroups({
      token: "1a2b3c4d5e6f7g8h9i10j11k",
      filter: "name eq 'My User Group'",
    });

    for await (const page of result) {
      console.log(page);
    }
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof errors.CventSDKError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);

      // Depending on the method different errors may be thrown
      if (error instanceof errors.ErrorResponse) {
        console.log(error.data$.code); // number
        console.log(error.data$.message); // string
        console.log(error.data$.target); // string
        console.log(error.data$.details); // ZeroAllOf1[]
      }
    }
  }
}

run();

Error Classes

Primary errors:

  • CventSDKError: The base class for HTTP error responses.
    • ErrorResponse: Represents an error response with additional details of cascading error messages. *
Less common errors (9)

Network errors:

Inherit from CventSDKError:

  • ErrorResponseJson20: The error response. Applicable to 11 of 444 methods.*
  • SegmentsErrorResponse: Segments error response details. Status code 400. Applicable to 2 of 444 methods.*
  • BadRequestError: A bad token response. Status code 400. Applicable to 1 of 444 methods.*
  • ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. See error.rawValue for the raw value and error.pretty() for a nicely formatted multi-line string.

* Check the method documentation to see if the error is applicable.

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the serverIdx: number optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

# Server Description
0 https://api-platform.cvent.com/ea
1 https://api-platform-eur.cvent.com/ea

Example

import { CventSDK } from "@cvent/sdk";

const cventSDK = new CventSDK({
  serverIdx: 0,
  security: {
    oAuth2ClientCredentials: {
      clientID: process.env["CVENTSDK_CLIENT_ID"] ?? "",
      clientSecret: process.env["CVENTSDK_CLIENT_SECRET"] ?? "",
      tokenURL: process.env["CVENTSDK_TOKEN_URL"] ?? "",
      scopes: process.env["CVENTSDK_SCOPES"] ?? "",
    },
  },
});

async function run() {
  const result = await cventSDK.users.getAccountUserGroups({
    token: "1a2b3c4d5e6f7g8h9i10j11k",
    filter: "name eq 'My User Group'",
  });

  for await (const page of result) {
    console.log(page);
  }
}

run();

Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:

import { CventSDK } from "@cvent/sdk";

const cventSDK = new CventSDK({
  serverURL: "https://api-platform-eur.cvent.com/ea",
  security: {
    oAuth2ClientCredentials: {
      clientID: process.env["CVENTSDK_CLIENT_ID"] ?? "",
      clientSecret: process.env["CVENTSDK_CLIENT_SECRET"] ?? "",
      tokenURL: process.env["CVENTSDK_TOKEN_URL"] ?? "",
      scopes: process.env["CVENTSDK_SCOPES"] ?? "",
    },
  },
});

async function run() {
  const result = await cventSDK.users.getAccountUserGroups({
    token: "1a2b3c4d5e6f7g8h9i10j11k",
    filter: "name eq 'My User Group'",
  });

  for await (const page of result) {
    console.log(page);
  }
}

run();

Override Server URL Per-Operation

The server URL can also be overridden on a per-operation basis, provided a server list was specified for the operation. For example:

import { CventSDK } from "@cvent/sdk";

const cventSDK = new CventSDK({
  security: {
    oAuth2ClientCredentials: {
      clientID: process.env["CVENTSDK_CLIENT_ID"] ?? "",
      clientSecret: process.env["CVENTSDK_CLIENT_SECRET"] ?? "",
      tokenURL: process.env["CVENTSDK_TOKEN_URL"] ?? "",
      scopes: process.env["CVENTSDK_SCOPES"] ?? "",
    },
  },
});

async function run() {
  const result = await cventSDK.cardTokens.createCardTokens({
    creditCard: {
      accountHolderName: "John Doe",
      expMonth: 11,
      expYear: 2026,
      cvv: "123",
      addressLine1: "123 Main Street",
      addressLine2: "First Floor",
      addressLine3: "Apt 101",
      addressCity: "McLean",
      addressStateProvince: "VA",
      addressPostalCode: "12345",
      addressCountry: "USA",
      addressCountryAlpha2: "US",
      contactPhone: "910-999-9999",
      email: "jdoe@example.com",
      number: "4111111111111111",
    },
  }, {
    serverURL: "https://secure-ecommerce.api-platform.cvent.com/ea",
  });

  console.log(result);
}

run();

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to:

  • route requests through a proxy server using undici's ProxyAgent
  • use the "beforeRequest" hook to add a custom header and a timeout to requests
  • use the "requestError" hook to log errors
import { CventSDK } from "@cvent/sdk";
import { ProxyAgent } from "undici";
import { HTTPClient } from "@cvent/sdk/lib/http";

const dispatcher = new ProxyAgent("http://proxy.example.com:8080");

const httpClient = new HTTPClient({
  // 'fetcher' takes a function that has the same signature as native 'fetch'.
  fetcher: (input, init) =>
    // 'dispatcher' is specific to undici and not part of the standard Fetch API.
    fetch(input, { ...init, dispatcher } as RequestInit),
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new CventSDK({ httpClient: httpClient });

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

Warning

Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

import { CventSDK } from "@cvent/sdk";

const sdk = new CventSDK({ debugLogger: console });

You can also enable a default debug logger by setting an environment variable CVENTSDK_DEBUG to true.

License

This SDK is licensed under the MIT License. See LICENSE.txt for the full license text.

For information about third-party dependencies and their licenses, see THIRD_PARTY_NOTICES.

Use of this SDK is subject to Cvent's Product Terms of Use.