Docs Integrations

Integrations

Connect Helpon with Slack, email, webhooks, Zapier, and use shortcodes to embed chat features anywhere on your site.

Overview

Helpon integrates with a wide range of external services to extend your chat assistant into the tools your team already uses. All integration settings are managed from Helpon → Settings → Integrations in your WordPress admin panel.

The following integrations are available out of the box:

  • Webhooks — Send real-time event data to any external URL
  • Slack — Receive chat notifications and respond from Slack channels
  • Email Notifications — Alert agents and admins of key events via email
  • Shortcodes — Embed chat widgets, knowledge base, booking, FAQ, and contact forms on any page
  • Follow-Up Emails — Automatically send transcripts, surveys, and re-engagement messages
  • REST API — Programmatic access to conversations, contacts, and messages
  • Zapier — Connect Helpon to 5,000+ apps with no-code automation
  • Third-Party Apps — Google Analytics, Facebook Pixel, and custom JavaScript hooks
ℹ️
Plan Availability

Webhooks, REST API, and Zapier integrations are available on the Pro plan and above. Slack, email notifications, and shortcodes are included in all plans.

Webhooks

Outgoing webhooks allow Helpon to send real-time HTTP POST requests to your server whenever specific events occur. This is ideal for syncing data with external CRMs, triggering custom workflows, or logging events to a third-party system.

Setting Up a Webhook

1

Navigate to Webhooks

Go to Helpon → Settings → Integrations → Webhooks and click Add Webhook.

2

Enter Webhook URL

Provide the HTTPS endpoint URL where Helpon should send event data. Only HTTPS URLs are accepted for security.

3

Select Events

Choose which events should trigger the webhook. You can subscribe to one or multiple events per endpoint.

4

Set Secret Key

Enter a secret key for signature verification. Helpon sends an X-Helpon-Signature header with each request, which is an HMAC-SHA256 hash of the payload body using your secret key.

Available Webhook Events

Event Trigger Description
conversation.started New chat begins Fired when a visitor initiates a new conversation
conversation.ended Chat closes Fired when a conversation is marked as resolved or closed
message.received New message Fired for each incoming visitor message
message.sent Agent/AI reply Fired when an agent or AI sends a response
contact.created New contact Fired when a new contact is added to the CRM
contact.updated Contact edited Fired when contact details are modified
appointment.booked New booking Fired when a visitor books an appointment
appointment.cancelled Booking cancelled Fired when an appointment is cancelled
agent.escalation Escalation Fired when a conversation is escalated to a human agent
offline.message Offline form Fired when a visitor submits an offline message

Payload Format

All webhook payloads are sent as JSON with the Content-Type: application/json header. Here is an example payload for the conversation.started event:

JSON — Webhook Payload
{
  "event": "conversation.started",
  "timestamp": "2026-03-03T14:22:08Z",
  "webhook_id": "wh_8a3b2c1d",
  "data": {
    "conversation_id": 1542,
    "channel": "web_chat",
    "visitor": {
      "name": "Sarah Johnson",
      "email": "sarah@example.com",
      "ip": "192.168.1.100",
      "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64)",
      "page_url": "https://example.com/services"
    },
    "assigned_agent": null,
    "ai_enabled": true,
    "tags": [],
    "metadata": {
      "referrer": "https://google.com",
      "utm_source": "organic"
    }
  }
}

Retry Logic

If a webhook delivery fails (non-2xx response or timeout), Helpon retries the request using exponential backoff:

  • Retry 1: After 30 seconds
  • Retry 2: After 5 minutes
  • Retry 3: After 30 minutes
  • Retry 4: After 2 hours
  • Retry 5: After 12 hours (final attempt)

After 5 failed attempts, the webhook is marked as failing and an admin notification is sent. You can view delivery logs and manually retry from the webhook detail page.

Signature Verification

Always verify the X-Helpon-Signature header on your server. Compute HMAC-SHA256 of the raw request body using your secret key and compare it to the header value to ensure the request is authentic.

Slack Integration

Connect Helpon to your Slack workspace so your team receives instant notifications for new chats, escalations, and offline messages directly in Slack channels.

Connecting Slack

1

Open Slack Settings

Navigate to Helpon → Settings → Integrations → Slack and click Connect Slack Workspace.

2

Authorize the App

You will be redirected to Slack's OAuth page. Select the workspace you want to connect and click Allow. Helpon requests permissions to post messages and read channel lists.

3

Select Notification Channel

After authorization, choose the Slack channel where notifications will be posted. You can create a dedicated channel like #helpon-notifications for better organization.

Slack Workspace
My Company Workspace (Connected)
Notification Channel
#helpon-notifications ▾
Escalation Channel
#helpon-escalations ▾
4

Configure Notification Events

Select which events trigger Slack notifications. You can assign different channels for different event types (e.g., escalations go to a priority channel).

Notification Events

Event Slack Message Content Default
New Chat Visitor name, page URL, first message preview Enabled
Agent Escalation Conversation link, visitor details, escalation reason Enabled
Offline Message Visitor name, email, message content Enabled
New Appointment Patient name, date/time, service type Disabled
New Contact Contact name, email, source channel Disabled

Slack Bot Commands

Once connected, the Helpon Slack bot supports these commands in your workspace:

  • /helpon status — View current online agents and active conversation count
  • /helpon recent — List the 5 most recent conversations with links
  • /helpon assign [conversation_id] [agent] — Assign a conversation to a specific agent
  • /helpon resolve [conversation_id] — Mark a conversation as resolved
  • /helpon stats — Quick summary of today's chat metrics

Email Notifications

Configure email alerts so your team never misses an important event. Email notifications are managed from Helpon → Settings → Integrations → Email Notifications.

Email Triggers

Trigger Description Default Recipients
New Conversation A visitor starts a new chat session All online agents
Agent Assigned A conversation is assigned to a specific agent Assigned agent
Offline Message A visitor submits a message when no agents are online Admin email + all agents
Escalation AI or a flow triggers a human escalation Available agents
Appointment Booked A visitor books a new appointment Admin email
Daily Summary End-of-day report with conversation and performance metrics Admin email

Recipient Settings

For each email trigger, you can configure recipients as:

  • All agents — Every agent registered in Helpon receives the email
  • Online agents only — Only agents currently marked as online
  • Assigned agent — Only the agent assigned to the conversation
  • Admin email — The WordPress admin email address
  • Custom emails — Enter one or more custom email addresses separated by commas

Email Template Customization

Helpon uses HTML email templates that can be customized under Helpon → Settings → Integrations → Email Templates. Available template variables include:

Email Subject
[Helpon] New conversation from {{visitor_name}}
Header Logo URL
https://example.com/logo.png
Primary Color
#2D8BC9
Footer Text
Sent by Helpon for {{business_name}}

SMTP Settings

By default, Helpon sends emails using WordPress's wp_mail() function. For better deliverability, configure a custom SMTP server under Helpon → Settings → Integrations → SMTP:

  • SMTP Host — Your mail server address (e.g., smtp.gmail.com)
  • SMTP Port — Typically 587 (TLS) or 465 (SSL)
  • Encryption — TLS (recommended) or SSL
  • Username — Your SMTP login username
  • Password — Your SMTP login password
  • From Name — Sender name shown in the email
  • From Email — Sender email address
Email Deliverability

Using a dedicated SMTP service like SendGrid, Mailgun, or Amazon SES significantly improves email deliverability and keeps your notifications out of spam folders.

Shortcodes

Helpon provides WordPress shortcodes to embed chat widgets, knowledge base articles, booking forms, FAQs, and contact forms on any page or post. Use these shortcodes in the WordPress editor, page builders, or template files.

[helpon_chat]

Embeds the chat widget inline on a page instead of as a floating bubble. Useful for dedicated support pages.

Shortcode
[helpon_chat position="inline" height="500" color="#2D8BC9" greeting="How can we help?"]

[helpon_kb]

Displays the knowledge base with search, categories, and article listings. Ideal for creating a self-service help center page.

Shortcode
[helpon_kb category="general" columns="3" search="true" limit="12"]

[helpon_booking]

Renders the appointment booking form with calendar, time slot selection, and service picker.

Shortcode
[helpon_booking service="consultation" provider="dr-smith" style="calendar"]

[helpon_faq]

Displays an accordion-style FAQ section pulled from your knowledge base articles tagged as FAQ.

Shortcode
[helpon_faq category="billing" limit="10" style="accordion" search="true"]

[helpon_contact_form]

Embeds a contact form that creates a new conversation and contact record in Helpon when submitted.

Shortcode
[helpon_contact_form fields="name,email,phone,message" subject="Website Inquiry" department="support"]

Shortcode Parameters Reference

Shortcode Parameter Values Default
[helpon_chat] position inline, bottom-right, bottom-left bottom-right
height Pixel value (e.g., 500) 600
color Hex color code Theme primary color
greeting Custom welcome text Settings default
[helpon_kb] category Category slug or all all
columns 1, 2, 3, 4 3
search true, false true
limit Number of articles 12
[helpon_booking] service Service slug or all all
provider Provider slug or any any
style calendar, list calendar
[helpon_faq] category Category slug or all all
limit Number of FAQs 10
style accordion, list accordion
search true, false false
[helpon_contact_form] fields Comma-separated field names name,email,message
subject Form subject line Contact Form
department Department slug general
ℹ️
Page Builder Compatibility

All Helpon shortcodes work with popular page builders including Elementor, WPBakery, Divi, and the Gutenberg block editor. Use the shortcode block/widget in your builder to embed them.

Follow-Up Emails

Helpon can automatically send follow-up emails to visitors after a chat session ends. Configure follow-up emails from Helpon → Settings → Integrations → Follow-Up Emails.

Setting Up Follow-Up Emails

1

Enable Follow-Up Emails

Toggle the Enable Follow-Up Emails switch to on. This activates the email queue for completed conversations.

2

Select Email Types

Choose which follow-up emails to send. You can enable multiple types simultaneously:

  • Chat Transcript — Sends the full conversation history to the visitor
  • Satisfaction Survey — Includes a link to rate the support experience
  • Re-Engagement — Follows up with visitors who left without resolution
3

Configure Timing

Set the delay for each email type. The timer starts after the conversation is marked as resolved or after the visitor leaves.

Chat Transcript Delay
5 minutes after resolution ▾
Satisfaction Survey Delay
1 hour after resolution ▾
Re-Engagement Delay
24 hours after last message ▾
Maximum Emails per Visitor (per week)
3 ▾
4

Customize Email Content

Edit the subject line, body text, and call-to-action for each email type. Use template variables like {{visitor_name}}, {{agent_name}}, {{conversation_summary}}, and {{survey_link}}.

⚠️
Email Consent

Follow-up emails are only sent to visitors who have provided their email address during the chat session. Helpon respects GDPR and CAN-SPAM compliance. Visitors can unsubscribe via the link included in every follow-up email.

REST API

The Helpon REST API provides programmatic access to your conversations, contacts, messages, and more. Use it to build custom integrations, dashboards, or sync data with external systems.

Authentication

All API requests require authentication via an API key passed in the request header. Generate your API key from Helpon → Settings → Integrations → REST API.

HTTP Header
X-Helpon-API-Key: your_api_key_here

Base URL

All API endpoints are available at:

Base URL
https://yoursite.com/wp-json/helpon/v1/

Rate Limits

Plan Requests per Minute Requests per Day
Pro 60 10,000
Business 120 50,000
Enterprise 300 Unlimited

When you exceed the rate limit, the API returns a 429 Too Many Requests response with a Retry-After header indicating when you can retry.

API Endpoints

List Conversations

Retrieve a paginated list of conversations with filters for status, date range, and agent.

cURL
curl -X GET "https://yoursite.com/wp-json/helpon/v1/conversations?status=open&per_page=20&page=1" \
  -H "X-Helpon-API-Key: your_api_key_here" \
  -H "Content-Type: application/json"

Create a Contact

Add a new contact to the Helpon CRM programmatically.

cURL
curl -X POST "https://yoursite.com/wp-json/helpon/v1/contacts" \
  -H "X-Helpon-API-Key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Jane Doe",
    "email": "jane@example.com",
    "phone": "+1-555-0123",
    "tags": ["new-patient", "web-lead"],
    "custom_fields": {
      "insurance_provider": "BlueCross",
      "preferred_location": "Downtown"
    }
  }'

Send a Message

Send a message to an existing conversation on behalf of an agent or the system.

cURL
curl -X POST "https://yoursite.com/wp-json/helpon/v1/conversations/1542/messages" \
  -H "X-Helpon-API-Key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "Thank you for reaching out! Your appointment has been confirmed for March 10th at 2:00 PM.",
    "sender_type": "agent",
    "agent_id": 3
  }'
💡
API Key Security

Never expose your API key in client-side JavaScript or public repositories. Always make API calls from your server-side code. Rotate your API key periodically from the Helpon settings panel.

Zapier

Connect Helpon to over 5,000 apps using Zapier's no-code automation platform. Create "Zaps" that automatically trigger actions in other apps when events occur in Helpon, or push data into Helpon from external sources.

Setting Up Zapier

1

Get Your Zapier API Key

Go to Helpon → Settings → Integrations → Zapier and copy your Zapier-specific API key. This key is separate from the REST API key for security.

2

Connect on Zapier

Log into zapier.com, search for Helpon in the app directory, and click Connect. Enter your site URL and Zapier API key when prompted.

3

Create a Zap

Click Create Zap and select Helpon as the trigger app. Choose your trigger event, then select the action app and configure the mapping.

4

Test & Enable

Test the Zap with sample data from Helpon. Once the test passes, turn on the Zap to start automating.

Available Triggers

  • New Conversation — Fires when a visitor starts a new chat
  • Conversation Resolved — Fires when a conversation is closed
  • New Contact — Fires when a new contact is created
  • New Appointment — Fires when a visitor books an appointment
  • Offline Message — Fires when a visitor submits an offline form
  • Agent Escalation — Fires when AI escalates to a human agent

Available Actions

  • Create Contact — Add a new contact to Helpon CRM
  • Update Contact — Update an existing contact's details
  • Send Message — Send a message in a conversation
  • Add Tag — Add a tag to a contact or conversation
  • Create Appointment — Book an appointment for a contact

Example Zaps

Trigger Action Use Case
Helpon: New Contact Google Sheets: Add Row Log every new lead to a spreadsheet for tracking
Helpon: New Appointment Gmail: Send Email Send a custom confirmation email to the patient
Helpon: Conversation Resolved Slack: Send Message Notify the team channel when a chat is resolved
Helpon: Offline Message Trello: Create Card Create a support ticket card for each offline message
Calendly: New Event Helpon: Create Contact Sync new Calendly bookings to Helpon CRM

Third-Party Apps

Helpon provides hooks and event tracking integrations for Google Analytics, Facebook Pixel, and custom JavaScript, allowing you to measure chat engagement and trigger custom behaviors.

Google Analytics Event Tracking

Enable Google Analytics tracking from Helpon → Settings → Integrations → Analytics. Helpon automatically sends events to your GA4 property when visitors interact with the chat widget.

JavaScript — GA4 Events Sent by Helpon
// Automatically fired by Helpon when GA tracking is enabled:

// When the chat widget is opened
gtag('event', 'helpon_chat_opened', {
  event_category: 'Helpon',
  event_label: 'Chat Widget Opened'
});

// When a visitor sends a message
gtag('event', 'helpon_message_sent', {
  event_category: 'Helpon',
  event_label: 'Visitor Message',
  value: 1
});

// When an appointment is booked via chat
gtag('event', 'helpon_appointment_booked', {
  event_category: 'Helpon',
  event_label: 'Appointment Booking',
  value: 1
});

// When a conversation is escalated to a human
gtag('event', 'helpon_escalation', {
  event_category: 'Helpon',
  event_label: 'Agent Escalation'
});

Facebook Pixel Integration

Enter your Facebook Pixel ID in Helpon → Settings → Integrations → Facebook Pixel. Helpon fires custom events for chat interactions that can be used for retargeting and conversion tracking.

JavaScript — Facebook Pixel Events
// Automatically fired by Helpon when FB Pixel is enabled:

fbq('trackCustom', 'HelponChatOpened');
fbq('trackCustom', 'HelponMessageSent');
fbq('trackCustom', 'HelponAppointmentBooked');
fbq('trackCustom', 'HelponContactFormSubmitted');

Custom JavaScript Hooks

Helpon exposes a JavaScript event system that lets you listen for chat events and execute custom logic on your frontend.

JavaScript — Custom Event Listeners
// Listen for when the chat widget opens
document.addEventListener('helpon:chat:opened', function(e) {
  console.log('Chat widget opened');
});

// Listen for when a visitor sends a message
document.addEventListener('helpon:message:sent', function(e) {
  console.log('Message sent:', e.detail.message);
});

// Listen for when a conversation ends
document.addEventListener('helpon:conversation:ended', function(e) {
  console.log('Conversation ended:', e.detail.conversation_id);
  // Trigger a custom survey popup
  showCustomSurvey(e.detail.conversation_id);
});

// Listen for when an appointment is booked
document.addEventListener('helpon:appointment:booked', function(e) {
  console.log('Appointment booked:', e.detail);
  // Redirect to a thank-you page
  window.location.href = '/thank-you/?booking=' + e.detail.appointment_id;
});

WordPress Action & Filter Hooks

For server-side customization, Helpon provides WordPress action and filter hooks that you can use in your theme's functions.php or a custom plugin.

PHP — WordPress Action Hooks
// Triggered when a new conversation is created
add_action('helpon_conversation_started', function($conversation) {
    // Log to a custom table or send to an external API
    error_log('New conversation #' . $conversation->id . ' from ' . $conversation->visitor_name);
});

// Triggered when a contact is created
add_action('helpon_contact_created', function($contact) {
    // Sync with an external CRM
    wp_remote_post('https://external-crm.com/api/contacts', array(
        'body' => json_encode(array(
            'name'  => $contact->name,
            'email' => $contact->email,
            'phone' => $contact->phone,
        )),
        'headers' => array('Content-Type' => 'application/json'),
    ));
});

// Filter the AI response before it is sent to the visitor
add_filter('helpon_ai_response', function($response, $conversation) {
    // Append a disclaimer to every AI message
    $response .= "\n\nNote: This response was generated by AI. For medical advice, please consult a professional.";
    return $response;
}, 10, 2);

// Filter the widget output before rendering
add_filter('helpon_widget_html', function($html) {
    // Add a custom CSS class to the widget wrapper
    return str_replace('class="helpon-widget"', 'class="helpon-widget my-custom-class"', $html);
});
💡
Hook Documentation

For the full list of available WordPress hooks, visit the Helpon → Settings → Integrations → Developer section, which includes a complete reference of all actions and filters with parameters.

Troubleshooting

Common integration issues and their solutions:

Webhook Not Receiving Data

  • Verify the webhook URL is accessible from the public internet (not localhost)
  • Check that your server returns a 2xx status code within 15 seconds — Helpon times out after 15 seconds
  • Ensure the webhook is set to Active in the webhook settings
  • Review the delivery log at Helpon → Settings → Integrations → Webhooks → [Your Webhook] → Logs
  • If your server requires IP whitelisting, whitelist the Helpon server IP shown on the webhook settings page
  • Make sure HTTPS is configured correctly on your receiving endpoint — self-signed certificates will cause failures

Slack Not Connecting

  • Ensure you are a Slack workspace admin or have permission to install apps
  • Try disconnecting and reconnecting the Slack integration from the Helpon settings
  • Verify the bot has been invited to the notification channel — type /invite @Helpon in the channel
  • Check if your Slack workspace has restrictions on third-party app installations
  • Clear browser cookies and try the OAuth flow again in an incognito window

Emails Going to Spam

  • Configure a dedicated SMTP service instead of relying on the default wp_mail() function
  • Set up SPF, DKIM, and DMARC records for your sending domain
  • Use a sender email address on your own domain (not a free email provider like Gmail)
  • Keep email content professional and avoid spam trigger words
  • Verify your sender domain in your SMTP provider's dashboard
  • Test email deliverability using tools like Mail Tester (mail-tester.com)

API Authentication Errors

  • Confirm the API key is passed in the X-Helpon-API-Key header (not as a URL parameter)
  • Check that the API key has not been regenerated — regenerating creates a new key and invalidates the old one
  • Verify your site URL matches the one registered with the API key
  • Ensure the REST API is enabled for your plan (Pro and above)
  • Check for WordPress plugins that may block REST API requests (some security plugins do this)
  • If using a .htaccess password on your site, ensure the API endpoint is excluded
⚠️
Firewall & Security Plugins

Security plugins like Wordfence, Sucuri, or iThemes Security may block incoming webhook callbacks or REST API requests. Add Helpon's endpoints to your security plugin's allowlist if you experience connectivity issues.