Documentation
    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

How can we help?

{{docApp.searchError}}
{{product.name}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

{{book.title}}
More...

Webinar / Create Webinar

  • Article
  • 3 minutes to read

Operation Information

Hornbill Integration method for creating a new Webinar in Zoom.

This is a Premium Integration.

Authentication

This operation requires authentication, the details of which can be securely stored on your instance in a KeySafe Key of type Zoom.

To create a key of this type:

  • In the Configuration area of your Hornbill instance, navigate to Platform Configuration > Security > KeySafe;
  • Click on the + Create New Key button;
  • On the resulting Create New Key form, choose Zoom in the Type pick list;
  • Give the Zoom KeySafe key a Title (this is the name / identifier for the Zoom account as you will see it when using the cloud automation node in your workflows);
  • Optionally populate the Description field;
  • Click the Create Key button to create your new key;
  • Once the Key is created, you will need to connect to the target service, and your account, in order to authorize the connector app access to the listed operations. Click the Connect button and you will be redirected to the service provider in a popup window;
  • Log in to your account, and then you will be prompted to review the options you are authorizing the Hornbill connector to be allowed to perform using the chosen account;
  • Accept the review and you will be returned to your KeySafe key.

Revoking Access

If at any point you wish to revoke access to any of the above accounts from your Hornbill instance, just hit the Revoke button in the relevant KeySafe key(s).

Warning

This will revoke the rights of any existing Cloud Automation Node in your Hornbill Workflows that are using the revoked Zoom account, so you will need to manage these workflows accordingly.

Input Parameters

Display Name ID Type Description Required Supported Values
User ID or Email user_id string The User ID or email address for the Webinar host Yes None provided
Topic topic string The Webinar topic No None provided
Webinar Type type number The Webinar Type Yes None provided
Start Time start_time string Webinar start time. When using a format like yyyy-MM-ddTHH:mm:ssZ, always use GMT time. When using a format like yyyy-MM-ddTHH:mm:ss, you should use local time and specify the time zone. This is only used for scheduled webinars and recurring webinars with a fixed time. No None provided
Duration duration number Webinar duration (minutes). Used for scheduled webinars only. No None provided
Time Zone timezone string Time zone to format start_time. For example, ‘America/Los_Angeles’. For scheduled webinars only. See https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones for more details. No None provided
Password password string Password to join the Webinar. Password may only contain the following characters: [a-z A-Z 0-9 @ - _ *]. Max of 10 characters. No None provided
Agenda agenda string Webinar description No None provided
Tracking Fields tracking_fields array Tracking Fields No None provided
Recurrence recurrence object Webinar Recurrence Settings No None provided
Settings settings object Meeting Settings No None provided

Output Parameters

Display Name ID Type Description
Status status string Response status
Start URL startUrl string Start URL
Host ID hostId string Host ID
Join URL joinUrl string Join URL
Webinar ID id string Also known as the Webinar Number
UUID uuid string Unique Webinar ID
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document