Gathering Compliance Data Guide
The Compliance APIs allow financial organizations to retrieve written communications from the Cvent platform and store them in their audit systems to maintain regulatory compliance.
This guide explains how to configure the compliance pipeline and ingest communications, including emails and chat.
Prerequisites#
This API is not enabled by default. Contact your account team to enable access to the Compliance API.
API Summary#
Name | Endpoint | Description |
---|---|---|
Get Communication Config | GET /logs/communications/configuration | View the types of communications stored for your account |
Update Communication Config | PUT /logs/communications/configuration | Update the types of communications stored for your account |
List Communication | GET /logs/communication/messages | Retrieve a paginated list of messages |
Filter Communication | POST /logs/communication/messages/filter | Retrieve a paginated list of messages with filters |
Adding Scopes#
Grant your workspace and application the
communications:read
and communications:write
scopes to interact with the Compliance APIs.
Configuring Compliance Settings#
Configure your desired compliance settings in your account:
- Call Get Configuration to view your current configuration.
- Call Update Configuration to specify the communication types (email and chat) you want to retrieve from Cvent.
Retrieving Communications#
To retrieve communications from your account, do the following:
- Call List Communication
to extract communications from Cvent. Use the
before
and/orafter
query parameters to retrieve details during a given time period. Optionally, you can also filter messages based on type if you'd like to process emails and chat separately. - Most message content will be returned in the response body. For emails, the API returns a signed URL where the full message content is accessible. These URLs are valid for 1 hour from the initial request. Store the content immediately to ensure retention.
Note
Messages are only stored for 30 days. Be sure to regularly retrieve data to ensure that all required messages are retained.