Knowledgebase articles
- Welcome to the Knowledge Base
- Introduction
- Getting Started
- Preferences
- Activities
- Cases
- Introduction to Cases
- Displaying & Adding Cases
- Managing Cases
- Using the Case Portal
- Email
- Importing Data
- Leads
- Marketing
- Introduction to Marketing
- Event Management
- Compliance Records
- Spotler Integration
- What is Spotler?
- Navigating your Spotler homepage
- Introduction to GatorMail
- GatorMail Configuration
- Sending Emails in GatorMail
- Advanced Features
- Setting up the Plugin
- Viewing Web Insights Data on your Form Layouts
- Domain Names and Online Activities
- 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?
- GatorSurvey
- GatorPopup
- Integrations
- SFTP/FTP Processes
- Mapping
- Docusign Integration
- DocuSign Functionality
- Adobe Sign Integration
- Zapier
- Introduction to Zapier
- Available Triggers and Actions
- Linking your Workbooks Account to Zapier
- 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
- Survey Monkey responses to Tasks
- Multistep Zaps
- Email Integrations
- Microsoft Office
- Auditing
- Comments
- People & Organisations
- Introduction to People & Organisations
- Using Postcode Lookup
- Data Enrichment
- Reporting
- Transaction Documents
- Displaying & Adding Transaction Documents
- Copying Transaction Documents
- Transaction Documents Fields Help
- Transaction Documents Line Items Help
- Printing & Sending Transaction Documents
- Managing Transaction Document Currencies
- Managing Transaction Document Statuses
- Setting a Blank Default Currency on Transaction Documents
- Credit Notes
- Customer Orders
- Invoices
- Quotations
- Supplier Orders
- Sagelink
- Configuration
- Workbooks Support: Your Go-To Guide
- Releases & Roadmap
API Keys
How to create API keys which can be used to allow external systems to communicate with Workbooks.
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.