Take control of your business integrations by learning how to use webhooks and API tokens to automate data transfers between the platform and other software applications.
Webhooks allow you to subscribe to events connected to a business account with your integration installed. Instead of making an API call, Webhooks can send an HTTP request to an endpoint you configure.
How are Webhooks and APIs different?
Webhooks and APIs differ in how they make requests. APIs will place calls for data regardless of whether there is a data update response. Webhooks receive calls through HTTP POSTs only when the connected system has a data update.
Using Webhooks or API
To set up a webhook, you have to register a URL. That URL will accept data and then activate a workflow. You can specify the situations where data will be delivered.
To connect to an API or a Webhook, you first need to access your API authentication token:
- Open the platform.
- In the main menu, click Settings.
- In the Settings menu, click Integrations.
Then access the Webhooks Module:
- Under "Webhooks", click Connect.
- Click Copy to Clipboard to copy the token.
- Paste the API token into your other apps as needed.
If you do not see your API token there or you do not have an integrations tab, please contact the account owner.
Frequently Asked Questions
Q: Who can access the API token within the platform?
Only the user designated as the Account Owner has the permissions required to view or copy the API token.
Q: Can the support team provide me with my API token?
No, the support team cannot provide API tokens to any users for security reasons.
Q: What should I do if I do not see the Integrations tab?
If the Integrations tab is missing from your Settings menu, contact the Account Owner to verify your permission levels or to obtain the token.
Q: How does a webhook differ from a standard API call?
A webhook sends data automatically via an HTTP POST when an event occurs, while an API requires you to manually request data.
Q: Where do I paste the API token once I copy it?
You paste the token into the authentication or settings field of the external application you wish to connect to the platform.
Q: Do I need to register a URL to use webhooks?
Yes, you must register a specific URL that will accept the data sent by the platform to trigger your external workflows.
Related to