API tokens are required to use Gladly APIs for security and authentication purposes. Tokens can be accessed and created by users who at least have an API user role.
For integrations not built by Gladly, a Gladly Administrator should create a new user with an API role + Agent and/or Administrator (check with your integration partner to confirm the required roles) account for each integration. This account should be used to access Gladly to create the API tokens or webhooks.
The integration partner should provide the email address to be used with the integration’s user account in Gladly. They must also access emails from this account to activate their Gladly account to create API tokens or webhooks.
API tokens are tied to a single user account and a particular environment. For example, an API token attached to Gladly user [email protected] in the Sandbox environment is not valid for [email protected] in the Production environment.
We recommend creating a dedicated Gladly user to make API calls whose account won’t be used for Agent and organization management. This will help you with any future audits of API activity vs. Agent activity.
Create a unique user account linked to webhooks or tokens #
As an Administrator, create a user to use explicitly to create and attach webhooks or tokens.
Be sure to add the user with at least an API User role + Agent and/or Administrator. If this user needs access to reports, they’ll need Administrator access. For a complete list of user permissions, click here.
Note – We recommend creating a dedicated user to make API calls.
Use the email address provided by the integration partner if you’re given one.
Use a name to help you quickly identify the integration user. For example, “Retale Integration.”
An email will be sent to the user. Someone must complete the registration and sign in to Gladly to create API tokens or webhooks. They’ll have 24 hours to accept the user invitation before it expires.
If a user account with API tokens or webhooks attached to it is deactivated, apps or external sources using the token or webhook linked to the user will stop working.
Create up to 50 webhooks for your organization. See our developer guide for more information about webhooks.
Click on the top left corner of the screen.
Click Settings.
Under the App Developer Toolscategory, click Webhooks. The Webhooks page will show you a list of webhooks you currently have configured.
Click Create Webhook.
From the Create Webhook page, enter the following information:
Name – Enter a name to help you identify the app using a webhook.
Enabled (toggle) – Allows you to activate/deactivate the webhook. Click the toggle so it’s green to activate the webhook.
Webhook URL – Enter the URL where you’d like to send events.
If you get an “unable to ping URL” error, double-check the URL and make sure it’s correct.
Events – Select the events you’d like to use from the search picklist. The Webhook Events you select are added below the search bar. For more information about Webhook Events, please visit our developer guide.
Username (Optional) – Enter the username for the app you are integrating.
Password (Optional) – Enter the password for the app you are integrating.
Realm (Optional) – Enter realm to run basic auth against.
HTTP Headers (Optional) – There are two columns (Header, Value) required for HTTP Headers (e.g., X-API-Key) to be included in every request.
Click Add a Header to add a new line.
Click to delete a line.
Click Save. This will take you back to the Webhooks page, where the webhook you just added is visible.
In the Status column, click the toggle next to the webhook you want to activate/deactivate. The toggle turns gray when it’s deactivated and green when activated.
Gladly automatically deactivates webhooks that fail. To see when a webhook was deactivated, hover over the exclamation point. Once the issue causing the webhook to fail is resolved, reactivate it. If the webhook is not being used, keep it deactivated or delete it if it is no longer used.
This website uses cookies to improve your experience while you navigate through the website. Out of these cookies, the cookies that are categorized as necessary are stored on your browser as they are essential for the working of basic functionalities of the website. We also use third-party cookies that help us analyze and understand how you use this website. These cookies will be stored in your browser only with your consent. You also have the option to opt-out of these cookies. But opting out of some of these cookies may have an effect on your browsing experience.
Necessary cookies are absolutely essential for the website to function properly. These cookies ensure basic functionalities and security features of the website, anonymously.
Cookie
Duration
Description
__cf_bm
29 minutes
This cookie, set by Cloudflare, is used to support Cloudflare Bot Management.
_wpfuuid
1 year 1 month 4 days
This cookie is used by the WPForms WordPress plugin. The cookie is used to allows the paid version of the plugin to connect entries by the same user and is used for some additional features like the Form Abandonment addon.
BIGipServer*
session
Marketo sets this cookie to collect information about the user's online activity and build a profile about their interests to provide advertisements relevant to the user.
cookielawinfo-checkbox-advertisement
1 year
Set by the GDPR Cookie Consent plugin, this cookie records the user consent for the cookies in the "Advertisement" category.
cookielawinfo-checkbox-analytics
11 months
This cookie is set by GDPR Cookie Consent plugin. The cookie is used to store the user consent for the cookies in the category "Analytics".
cookielawinfo-checkbox-functional
11 months
The cookie is set by GDPR cookie consent to record the user consent for the cookies in the category "Functional".
cookielawinfo-checkbox-necessary
11 months
This cookie is set by GDPR Cookie Consent plugin. The cookies is used to store the user consent for the cookies in the category "Necessary".
cookielawinfo-checkbox-others
11 months
This cookie is set by GDPR Cookie Consent plugin. The cookie is used to store the user consent for the cookies in the category "Other.
cookielawinfo-checkbox-performance
11 months
This cookie is set by GDPR Cookie Consent plugin. The cookie is used to store the user consent for the cookies in the category "Performance".
CookieLawInfoConsent
1 year
CookieYes sets this cookie to record the default button state of the corresponding category and the status of CCPA. It works only in coordination with the primary cookie.
PHPSESSID
session
This cookie is native to PHP applications. The cookie stores and identifies a user's unique session ID to manage user sessions on the website. The cookie is a session cookie and will be deleted when all the browser windows are closed.
viewed_cookie_policy
11 months
The cookie is set by the GDPR Cookie Consent plugin and is used to store whether or not user has consented to the use of cookies. It does not store any personal data.
Functional cookies help to perform certain functionalities like sharing the content of the website on social media platforms, collect feedbacks, and other third-party features.
Cookie
Duration
Description
li_gc
5 months 27 days
Linkedin set this cookie for storing visitor's consent regarding using cookies for non-essential purposes.
lidc
1 day
LinkedIn sets the lidc cookie to facilitate data center selection.
UserMatchHistory
1 month
LinkedIn sets this cookie for LinkedIn Ads ID syncing.
Performance cookies are used to understand and analyze the key performance indexes of the website which helps in delivering a better user experience for the visitors.
Analytical cookies are used to understand how visitors interact with the website. These cookies help provide information on metrics the number of visitors, bounce rate, traffic source, etc.
Cookie
Duration
Description
_ga
1 year 1 month 4 days
Google Analytics sets this cookie to calculate visitor, session and campaign data and track site usage for the site's analytics report. The cookie stores information anonymously and assigns a randomly generated number to recognise unique visitors.
_ga_*
1 year 1 month 4 days
Google Analytics sets this cookie to store and count page views.
_gd_session
4 hours
This cookie is used for collecting information on users visit to the website. It collects data such as total number of visits, average time spent on the website and the pages loaded.
_gd_visitor
1 year 1 month 4 days
This cookie is used for collecting information on the users visit such as number of visits, average time spent on the website and the pages loaded for displaying targeted ads.
_sp_id.*
1 year 1 month 4 days
Snowplow sets this cookie to store user information that is created when a user first visits a site and is updated on subsequent visits.
_sp_ses.*
30 minutes
Snowplow sets this cookie to store user information that is created when a user first visits a site and is updated on subsequent visits.
AnalyticsSyncHistory
1 month
Linkedin set this cookie to store information about the time a sync took place with the lms_analytics cookie.
mf_user
3 months
Mouseflow sets this cookie to identify whether a visitor is new or returning.
vuid
1 year 1 month 4 days
Vimeo installs this cookie to collect tracking information by setting a unique ID to embed videos on the website.
Advertisement cookies are used to provide visitors with relevant ads and marketing campaigns. These cookies track visitors across websites and collect information to provide customized ads.
Cookie
Duration
Description
_mkto_trk
1 year 1 month 4 days
This cookie, provided by Marketo, has information (such as a unique user ID) that is used to track the user's site usage. The cookies set by Marketo are readable only by Marketo.
bcookie
1 year
LinkedIn sets this cookie from LinkedIn share buttons and ad tags to recognize browser IDs.
bscookie
1 year
LinkedIn sets this cookie to store performed actions on the website.
li_sugr
3 months
LinkedIn sets this cookie to collect user behaviour data to optimise the website and make advertisements on the website more relevant.