Wingmate designs it's features to be easily integrated into any of your other systems, such as marketing engines, enterprise resource planners, business intelligence tools, etc. If you are looking to complete an integration with Wingmate, you have several tools in your arsenal.
In this section, we will review what is available to you on your journey to build an integration to Wingmate.
API Access
To begin your journey on integrating with Wingmate, you must purchase the "API Access & Integrations" add-on from Wingmate. This add-on provides you with the ability to not only use our API and Webhook features, but you also gain access to:
- Our official Outlook Integration and Gmail Integration.
- Access to other official integrations including Jobber, customer.io and much more.
- Access to use our API and Webhook functionalities.
- Access to use our Zapier tools.
Want to add this add-on? Follow the steps below to enable API Access & Integrations on your pipeline:
- Log in to Wingmate as an administrator account.
- Go to the Admin Console by clicking the settings icon in the side menu.
- Scroll to the bottom of the admin console and click "Integrate with Wingmate".
- A page will describe the costs and capabilities of the API Access & Integrations add-on. Click "Accept" to add the add-on and begin your integration journey.
- When the add-on is added to your company profile, your integration page will appear as the following.
After accepting the add-on, you're all set to begin integrating! This next section will describe your first steps towards completing this integration.
Authentication
Your first step to begin building your integration with Wingmate is to retrieve your API Token. For your integration purposes, it is important to determine the level of access you need.
There are three levels of API Access:
| Access Level | Description | How to get your token |
| User |
Access the system as a user. You will only have access to objects that the user can access depending on their type. |
Can be retrieved using the Pipeline/Company API key and requesting GET /users |
| Pipeline | Access the objects stored on the authorized Pipeline and use CRUD functions to read/modify them. | Follow this guide to retrieve a Pipeline API Key. |
| Company | Access all objects stored on the pipeline(s) your company has. This level of access allows you to use CRUD functions on all objects/users. | Must be secure sent to you by our operational staff (email co@wingmateapp.com). |
API Documentation
Ready to start? Click here to view our available API endpoints and learn about the models of Wingmate. If you have any questions, never hesitate to reach out to dev@wingmateapp.com!
Additional Resources
- How to retrieve your Pipeline API Token: https://support.wingmateapp.com/hc/en-us/articles/33637833792781-Integrating-with-Wingmate-Retrieving-your-Pipeline-API-Token
- Our OpenAPI Documentation: https://api.wingmateapp.com/api-docs/index.html
- How to use Wingmate's API and Webhooks: https://support.wingmateapp.com/hc/en-us/articles/33639385554061-Integrating-with-Wingmate-Using-Wingmate-s-API-and-Webhooks