Helpshift Webhooks allow you to set up an integration with a third party service, such as Slack, PowerBI, a bot engine, and others, based on Helpshift events. You can use the integration to enable notifications via text, email or a communication app whenever a Helpshift event occurs. Within the Helpshift Dashboard, you can define the conditions required to receive a notification.
From the Helpshift Dashboard, you can define your own HTTP callback to trigger an action or notification through a Helpshift event. For each Webhook, you’ll need to configure corresponding listeners and subscribe it to events. The Webhook listener will look out for your defined URL for incoming HTTPS POST notification messages.
Examples of popular services that can connect to Helpshift using Webhooks are:
- Analytics engines like PowerBI
- Bot engines, such as Facebook Messenger
With Webhooks, you can accomplish the following:
- Notifications for all new Issues created in the Helpshift Dashboard
- Notifications for specific new Issues (For example, Android users that are tagged as ‘VIP’)
- Notifications for changes to all existing Issues
- Notifications for changes to specific Issues (For example, notifications when someone modifies iOS Issues with the Spanish language tag)
Webhooks can only be created by the Admin(s) of your team. If you are an Agent, please refer your Admin to review this article.
To create your first Webhook, proceed as follows:
1. Navigate to Settings > APIs > scroll down to the Webhooks section
2. Click the ‘Add Webhook’ button
3. Complete the following info in the pop-up that appears:
- Webhook name: The name of the Webhook, which will be unique to your domain
- Target URL: The required HTTPS URL – we only allow HTTPS listener URLs to ensure data encryption to prevent unauthorized access
- Authentication mechanism: Helpshift offers the following options to allow you to add an extra layer of security:
- Basic auth: Username and password based
- Custom auth: Secret key based
- No auth: If chosen, no authentication is applied – this gives you flexibility while testing
- App: Select one or many apps with Helpshift integrated
- Events: Select Issue creation or an update to an Issue – this is where you can define custom criteria for your notifications
- Custom Criteria: Here you can specify the target criteria for your Webhook notifications. Instead of targeting all Issues, notifications are triggered when changes occur to the Issues that match the custom criteria defined. In the example below, we’ve se tup notifications for iOS and Android Issues that are missing custom metadata.
- Notification delivery failure email: An optional field for you to get notified via email when a notification delivery fails
4. Once you click Save, the Webhook will start working immediately.
To modify or delete a Webhook, click on the the gear icon to the right of the Webhook name. A pop-up will appear where you can update all of the relevant info for this Webhook.