Generated by API Evangelist
Written by API Evangelist tooling for Cvent Registration's API. It is a proposal applied on top of the contract, not a document Cvent Registration publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Cvent REST Authentication API
version: 1.0.0
extends: openapi/cvent-registration-authentication-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 3
- target: $.paths['/oauth2/authorize'].get
update:
x-apievangelist-phrasing:
intent: Start the OAuth2 authorization code flow
effect: read
questions:
- How do I send a user to Cvent to authorize my app and get an authorization code?
- Does the redirect URI have to use HTTPS, or can I use localhost while testing?
instructions:
- text: Build the authorization URL for client {client_id} redirecting to {redirect_uri}.
slots:
client_id: query.client_id
redirect_uri: query.redirect_uri
- text: Request an authorization code of type {response_type} for {client_id} with scope {scope}, returning to {redirect_uri}.
slots:
response_type: query.response_type
client_id: query.client_id
scope: query.scope
redirect_uri: query.redirect_uri
method: generated
generated: '2026-09-26'
- target: $.paths['/oauth2/token'].post
update:
x-apievangelist-phrasing:
intent: Get an access token
effect: write
questions:
- How do I exchange my client credentials for an API access token?
- When do I get a refresh token back from the token endpoint?
- Can I use a refresh token to get a new access token?
instructions:
- text: Get an access token for client {client_id} using grant type {grant_type}.
slots:
client_id: requestBody.client_id
grant_type: requestBody.grant_type
- text: Exchange authorization code {code} for tokens for client {client_id}.
slots:
code: requestBody.code
client_id: requestBody.client_id
- text: Refresh my access token with refresh token {refresh_token}.
slots:
refresh_token: requestBody.refresh_token
method: generated
generated: '2026-09-26'
- target: $.paths['/token-validation'].get
update:
x-apievangelist-phrasing:
intent: Check that an access token is valid
effect: read
questions:
- Is my current access token still valid?
- Can I verify a token before making other calls?
instructions:
- text: Validate my current access token.
- text: Check whether the token I'm using is still accepted.
method: generated
generated: '2026-09-26'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.