GoToWebinar · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Gotowebinar Webhooks API
12 actions
12 updates
phrasing
extends
openapi/gotowebinar-webhooks-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for GoToWebinar's API. It is a proposal applied on top of the contract, not a document GoToWebinar publishes.
What the actions change
x-apievangelist-phrasing
Targets 12
$.info
$.paths['/webhooks/secretkey'].post
$.paths['/webhooks'].get
$.paths['/webhooks'].put
$.paths['/webhooks'].post
$.paths['/webhooks'].delete
$.paths['/webhooks/{webhookKey}'].get
$.paths['/userSubscriptions'].get
$.paths['/userSubscriptions'].put
$.paths['/userSubscriptions'].post
$.paths['/userSubscriptions'].delete
$.paths['/userSubscriptions/{userSubscriptionsKey}'].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 Gotowebinar Webhooks API
version: 1.0.0
extends: openapi/gotowebinar-webhooks-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['/webhooks/secretkey'].post
update:
x-apievangelist-phrasing:
intent: Create a webhook signing secret key
effect: write
questions:
- How do I get a secret key to verify the signature on webhook events?
- Can I schedule a new webhook secret key to activate at a future date?
instructions:
- text: Generate a new webhook signing secret for my application.
- text: Create a webhook secret key that becomes active at {validFrom}.
slots:
validFrom: requestBody.validFrom
method: generated
generated: '2026-10-01'
- target: $.paths['/webhooks'].get
update:
x-apievangelist-phrasing:
intent: List my webhooks for a product
effect: read
questions:
- Which webhooks have I registered for GoTo Webinar?
- Do I have to specify a product when listing my webhooks?
instructions:
- text: List my webhooks for product {product}.
slots:
product: query.product
- text: Show the webhooks I own under the {product} product.
slots:
product: query.product
method: generated
generated: '2026-10-01'
- target: $.paths['/webhooks'].put
update:
x-apievangelist-phrasing:
intent: Update webhooks' callback URL or state
effect: write
questions:
- How do I change the callback URL on webhooks I already created?
- Can I deactivate several webhooks in one call?
instructions:
- text: Update the callback URL and state on my existing webhooks.
- text: Switch my webhooks to inactive in a single update.
method: generated
generated: '2026-10-01'
- target: $.paths['/webhooks'].post
update:
x-apievangelist-phrasing:
intent: Create new webhooks with a callback URL
effect: write
questions:
- How do I register a new webhook to receive webinar events?
- Does my webhook callback have to be HTTPS and answer 200 OK to a validation GET?
instructions:
- text: Create a new webhook pointing to my HTTPS callback endpoint.
- text: Register webhooks for the webinar events my app needs to receive.
method: generated
generated: '2026-10-01'
- target: $.paths['/webhooks'].delete
update:
x-apievangelist-phrasing:
intent: Delete webhooks by key
effect: destructive
questions:
- How do I delete webhooks I no longer use?
- Can I remove several webhooks at once by passing their keys?
instructions:
- text: Delete my unused webhooks by their webhook keys.
- text: Remove the listed webhooks in one bulk delete.
method: generated
generated: '2026-10-01'
- target: $.paths['/webhooks/{webhookKey}'].get
update:
x-apievangelist-phrasing:
intent: Get one webhook by key
effect: read
questions:
- What callback URL and event is a particular webhook set up for?
- Can I fetch a single webhook's details by its key?
instructions:
- text: Get webhook {webhookKey}.
slots:
webhookKey: path.webhookKey
- text: Show the configuration of webhook {webhookKey}.
slots:
webhookKey: path.webhookKey
method: generated
generated: '2026-10-01'
- target: $.paths['/userSubscriptions'].get
update:
x-apievangelist-phrasing:
intent: List user subscriptions for a product
effect: read
questions:
- Which user subscriptions exist on my webhooks for a given product?
- Is a product required when listing webhook user subscriptions?
instructions:
- text: List my user subscriptions for product {product}.
slots:
product: query.product
- text: Show every webhook user subscription under the {product} product.
slots:
product: query.product
method: generated
generated: '2026-10-01'
- target: $.paths['/userSubscriptions'].put
update:
x-apievangelist-phrasing:
intent: Bulk update user subscriptions
effect: write
questions:
- How do I change the callback URL on several user subscriptions together?
- Can I turn multiple user subscriptions off in one request?
instructions:
- text: Update callback URLs and states across my user subscriptions in bulk.
- text: Deactivate a batch of user subscriptions in one call.
method: generated
generated: '2026-10-01'
- target: $.paths['/userSubscriptions'].post
update:
x-apievangelist-phrasing:
intent: Create user subscriptions for a webhook
effect: write
questions:
- How do I subscribe users to a webhook I already created?
- Can each new user subscription have its own callback URL?
instructions:
- text: Create user subscriptions for my webhook with their callback URLs.
- text: Add new user subscriptions so events flow to our callback.
method: generated
generated: '2026-10-01'
- target: $.paths['/userSubscriptions'].delete
update:
x-apievangelist-phrasing:
intent: Delete user subscriptions by key
effect: destructive
questions:
- How do I remove a batch of user subscriptions at once?
- Can I delete user subscriptions by passing a list of their keys?
instructions:
- text: Delete the listed user subscriptions by their keys.
- text: Bulk remove user subscriptions I no longer need.
method: generated
generated: '2026-10-01'
- target: $.paths['/userSubscriptions/{userSubscriptionsKey}'].get
update:
x-apievangelist-phrasing:
intent: Get one user subscription by key
effect: read
questions:
- What are the details of a single webhook user subscription?
- Can I check one user subscription's callback and state by its key?
instructions:
- text: Get user subscription {userSubscriptionsKey}.
slots:
userSubscriptionsKey: path.userSubscriptionsKey
- text: Show the callback and state of user subscription {userSubscriptionsKey}.
slots:
userSubscriptionsKey: path.userSubscriptionsKey
method: generated
generated: '2026-10-01'