Conga · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Conga Callback API
12 actions
12 updates
phrasing
extends
openapi/conga-callback-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Conga's API. It is a proposal applied on top of the contract, not a document Conga publishes.
What the actions change
x-apievangelist-phrasing
Targets 12
$.info
$.paths['/v1/cs-callback'].get
$.paths['/v1/cs-callback'].post
$.paths['/v1/cs-callback/connectors/{origin}'].get
$.paths['/v1/cs-callback/connectors/{origin}'].post
$.paths['/api/extensibility/v1/callbacks'].get
$.paths['/api/extensibility/v1/callbacks'].put
$.paths['/api/extensibility/v1/callbacks/modules'].get
$.paths['/api/extensibility/v1/callbacks/modules/{moduleName}'].get
$.paths['/api/extensibility/v1/callbacks/settings'].get
$.paths['/api/extensibility/v1/callbacks/settings'].put
$.paths['/api/extensibility/v1/callbacks/{name}'].get
OpenAPI Overlay
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Conga Callback API
version: 1.0.0
extends: openapi/conga-callback-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-01'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 11
- target: $.paths['/v1/cs-callback'].get
update:
x-apievangelist-phrasing:
intent: Get my package event callback
effect: read
questions:
- What webhook URL is set to receive package event notifications?
- Which events is my callback subscribed to?
instructions:
- text: Show my package event callbacks.
- text: List the configured callback URLs and events.
method: generated
generated: '2026-10-01'
- target: $.paths['/v1/cs-callback'].post
update:
x-apievangelist-phrasing:
intent: Register a package event callback
effect: write
questions:
- How do I get notified at my URL when a package is signed?
- Can I set custom headers or OAuth on an event callback?
instructions:
- text: Register callback URL {url} for events {events}.
slots:
url: requestBody.url
events: requestBody.events
- text: Set up a callback to {url} using key {key}.
slots:
url: requestBody.url
key: requestBody.key
method: generated
generated: '2026-10-01'
- target: $.paths['/v1/cs-callback/connectors/{origin}'].get
update:
x-apievangelist-phrasing:
intent: Get callbacks for a connector
effect: read
questions:
- What callbacks are configured for my SharePoint or Dynamics connector?
- How do I check a connector's callback settings?
instructions:
- text: List callbacks for connector {origin}.
slots:
origin: path.origin
- text: Show the {origin} connector's callback configuration.
slots:
origin: path.origin
method: generated
generated: '2026-10-01'
- target: $.paths['/v1/cs-callback/connectors/{origin}'].post
update:
x-apievangelist-phrasing:
intent: Register a callback for a connector
effect: write
questions:
- How do I add an event callback for a Dynamics connector?
- Can each connector have its own callback URL?
instructions:
- text: Register callback URL {url} for connector {origin}.
slots:
url: requestBody.url
origin: path.origin
- text: Create a {origin} connector callback for events {events}.
slots:
origin: path.origin
events: requestBody.events
method: generated
generated: '2026-10-01'
- target: $.paths['/api/extensibility/v1/callbacks'].get
update:
x-apievangelist-phrasing:
intent: List all custom code callback contracts
effect: read
questions:
- Which callback contracts exist for custom code extensibility?
- How can I see which custom code project each callback contract is mapped to?
instructions:
- text: List every callback contract with its custom code project mapping.
- text: Show all extensibility callback contracts across modules.
method: generated
generated: '2026-10-01'
- target: $.paths['/api/extensibility/v1/callbacks'].put
update:
x-apievangelist-phrasing:
intent: Map a callback contract to custom code
effect: write
questions:
- How do I point a callback contract at my own custom code project and class?
- Can I change which custom code class handles a callback contract?
instructions:
- text: Update the callback contract mapping to use my custom code project and class.
- text: Remap this callback contract to a different custom code class.
method: generated
generated: '2026-10-01'
- target: $.paths['/api/extensibility/v1/callbacks/modules'].get
update:
x-apievangelist-phrasing:
intent: List modules that expose callbacks
effect: read
questions:
- Which modules have registered extensibility callbacks?
- What callback modules can I write custom code against?
instructions:
- text: List the registered callback modules.
- text: Show every module that offers custom code callbacks.
method: generated
generated: '2026-10-01'
- target: $.paths['/api/extensibility/v1/callbacks/modules/{moduleName}'].get
update:
x-apievangelist-phrasing:
intent: List callback contracts for one module
effect: read
questions:
- Which callback contracts does a particular module expose?
- Can I see the custom code mappings for just one module's callbacks?
instructions:
- text: List callback contracts in module {moduleName}.
slots:
moduleName: path.moduleName
- text: Show the custom code mappings for all callbacks of module {moduleName}.
slots:
moduleName: path.moduleName
method: generated
generated: '2026-10-01'
- target: $.paths['/api/extensibility/v1/callbacks/settings'].get
update:
x-apievangelist-phrasing:
intent: Get callback custom code settings
effect: read
questions:
- What timeout is configured for callback custom code execution?
- Where do I check the current callback custom code setting configuration?
instructions:
- text: Show the callback custom code settings.
- text: Get the configured abort timeout for callback custom code.
method: generated
generated: '2026-10-01'
- target: $.paths['/api/extensibility/v1/callbacks/settings'].put
update:
x-apievangelist-phrasing:
intent: Set the callback custom code timeout
effect: write
questions:
- How do I change how long callback custom code can run before it is aborted?
- Can I create the callback custom code settings if none are configured yet?
instructions:
- text: Set the callback custom code abort timeout to {ExecutionAbortTimeout} milliseconds.
slots:
ExecutionAbortTimeout: requestBody.ExecutionAbortTimeout
- text: Upsert callback settings with an execution abort timeout of {ExecutionAbortTimeout} ms.
slots:
ExecutionAbortTimeout: requestBody.ExecutionAbortTimeout
method: generated
generated: '2026-10-01'
- target: $.paths['/api/extensibility/v1/callbacks/{name}'].get
update:
x-apievangelist-phrasing:
intent: Get one callback contract by name
effect: read
questions:
- What are the details and mapping of a specific named callback contract?
- Can I look up a callback contract by name within a module?
instructions:
- text: Get callback contract {name}.
slots:
name: path.name
- text: Show callback contract {name} in module {moduleName}.
slots:
name: path.name
moduleName: query.moduleName
method: generated
generated: '2026-10-01'