Wingmate provides bi-directional integration capabilities:
- Our API allows you to perform CRUD operations on all of the objects in your pipeline.
- Our Webhook model allows you to listen to events in Wingmate as they occur and handle them in your integration.
Using our API
To use the Wingmate API, you must have an API token to authenticate with. You can follow this guide here to retrieve your Pipeline API Token.
Add the API token to your headers with the Bearer token authorization method:
{
"Authorization": "Bearer <YOUR_API_TOKEN_HERE>",
}
With the header above, you can request the following API to ensure you are authenticated:
GET https://api.wingmateapp.com/api/v1.0
View our API docs to see the rest of the API endpoints you can request: https://api.wingmateapp.com/api-docs/index.html
Creating a Webhook
The guide below will show you how to set up a Webhook to point to your integration server.
Note: To create a Webhook, you must be an administrator. Not an admin? Speak to your companies' Wingmate representative about gaining access.
1. Go to the Admin Console
Click on the Cog or "Admin Console" on the side navigation menu to navigate to the Admin Console.
2. Go to "Integrate with Wingmate"
Scroll down to the bottom of the admin console and click "Integrate with Wingmate".
On this page, you will be able to create an API key for your pipeline, navigate to our API documentation and maintain your Webhooks.
3. Click the "+" Button to add a Webhook
To add a Webhook, click the "+" button to open up the new Webhook Modal form.
4. Fill out the Details of the Webhook
Add the necessary information to set up the Webhook. Each field in the form is described below:
Input | Description | Acceptable values |
Endpoint | The endpoint Wingmate will request when a Webhook event is triggered. It will always submit a request with a POST REST type. | A URL to the endpoint you wish to be requested with a POST request. |
Event(s) | The event(s) the Webhook triggers on. You can select multiple events to call the same endpoint, making Create and/or Update flows easy to manage. | It must be a selection of the possible create/update/deletion events for each Model in Wingmate |
Additional Headers | A list of headers you wish for Wingmate to add to the request. | Colon-separated with a newline between each Header. |
After entering the information, press "Submit" to save the Webhook.
5. Test out your Webhook
Want to know what happens when Wingmate requests your Webhook? We store some common metadata of the request and you can see the response on the Admin Console > Webhook Requests page. Go to that page and see more details on what response we received from your integration.
6. Have Questions?
You're all set to begin building Webhooks with Wingmate! Have any questions? Reach out to our development staff at dev@wingmateapp.com. We are always happy to help you build with Wingmate!