- Welcome to the Knowledge Base
- Introduction
- Training
- Desktop Environment
- Preferences
- Activities
- Cases
- Forecasts & Quotas
- Importing Data
- Leads
-
Marketing
- Introduction to Marketing
- Marketing Campaigns
- Mailing Lists
- Products
- Mailshots
- Upload Library
- Templates
-
Workbooks Web Insights
- Tracking Code
- Setting up the Plugin
- Viewing Web Insights Data on your Form Layouts
- Domain Names and Online Activities
- Gator Popup
- Reporting incorrect Leads created through Web Insights
- Reporting on Web Insights data
- Using UTM Values
- Why aren’t Online Activities being created in the database?
- Why is GatorLeads recording online activities in a foreign language?
- Using HubSpot with Workbooks
- Event Management
- Compliance Records
- GatorMail Integration
- Opportunities
-
Integrations
- Mapping
- Electronic Signing Tools
- Creditsafe Integration
-
Zapier
- Introduction to Zapier
- Available Triggers and Actions
- Linking your Workbooks Account to Zapier
-
Setting up Zaps
- Posted Invoices to Xero Invoices
- Xero payments to Workbooks Tasks
- New Case to Google Drive folder
- New Case to Basecamp Project
- New Workbooks Case to JIRA Ticket
- Jira Issue to new Case
- 123FormBuilder Form Entry to Case
- Eventbrite Attendee to Sales Lead and Task
- Facebook Ad Leads to Sales Leads
- Wufoo Form Entry to Sales Lead
- Posted Credit Note to Task
- QuickBooks Online
- Survey Monkey responses to Tasks
- Multistep Zaps
-
Email Integrations
- Email Dropbox
- Workbooks Exchange Server Sync
- Workbooks Outlook Connector
-
Event & Webinar Integration Tools
- GoToWebinar
- ON24
- Microsoft Office
- Outreach
- Scribe/Workbooks Connector
- People & Organisations
- Reporting
- Dashboards
- Transaction Documents
- Auditing
-
Configuration
- Introduction to System Administration
- Users & Security
- Database
- Accounting
- Email & Integration
- Customisation
- Automation
- PDF Configuration
- Contact Support
-
Releases & Roadmap
- Roadmap
- March 2021 Release
- December 2020 Release
- September 2020 Release
- April 2020 Release
- January 2020 Release
- September 2019 Release
- February 2019 - Event Management Release
- January 2019 Release
- October 2018 Release
- May 2018 Release
- February 2018 Release
- January 2018 Release
- November 2017 Release
- September 2017 Release
- June 2017 Release
- March 2017 Release
- December 2016 Release
- August 2016 Release
- January 2016 Release
- Workbooks Glossary
API Keys
You can integrate external systems with Workbooks using the Workbooks API. Using API keys allow external systems to access a specified Workbooks Database on the user's behalf, with all of their Capabilities and Permissions.
Creating an API Key in order to allow external systems to communicate with Workbooks removes the need for the external system to login using a username and password each time.
An API Key can be created by going to Start > Configuration > Email & Integration > API Keys > New API Key.
Select a user using the dropdown picklist next to 'Access as User'. This determines which user the API Key will run as, with their Capabilities and Permissions. Give the API Key a name which you can use to easily identify what it is used for. It is also helpful to add a meaningful description
Further to this, you can specify certain login restrictions, such as a range of dates for which the API Key is valid and one or more IP addresses from which the API Key can be used. If you specify more than one IP address you should separate them using a comma. You can also restrict the API Key's Capabilities to a subset of those of the User which you have selected. If you do not, then the API Key will adopt the same Capabilities as specified in the "Access as User" field.
Click Save & Close. The API key will now appear in the grid on the right.
NOTE: If you delete or disable a user who is designated as the 'Access as User', the external system will no longer be able to communicate with Workbooks. In this circumstance, you should edit the API Key.
Related content