Skip to main content
For Developers

Build anything.
Connect everything.

Full HTTP API, webhooks, Zapier, and direct database access. HelpSpot is a platform you can build on, not a black box you're locked into.

View API Docs Start Free Trial

Multiple ways to integrate

F-01

HTTP API

Full CRUD access to tickets, users, categories, custom fields, and more. Build anything you can imagine.

F-02

Webhooks

Push data to external systems when events occur. Triggered by automation rules with dozens of conditions.

F-03

Zapier

5,000+ app connections with zero code. Slack, Teams, Salesforce, Google Sheets, and thousands more.

F-04

Live Lookup

Pull customer data from your CRM, ERP, or Active Directory in real-time. No sync required. Write custom PHP to connect any data source.

F-05

Request Push

One-click button on every ticket sends details to bug trackers, CRMs, or any external system.

F-06

Database Access

Self-hosted customers get full SQL access. Connect Tableau, Power BI, or any reporting tool directly.

HTTP API

Full access to everything

Create, read, and update tickets and nearly all HelpSpot subsystems. Build custom dashboards, integrate with internal tools, or create entirely new interfaces on top of HelpSpot.

  • Create, read, update operations on all resources
  • Access tickets, users, categories, custom fields
  • Build custom reports and dashboards
  • Power mobile apps or internal tools
GET /api/index.php
# Get a ticket
curl -X GET \
"https://yoursite.helpspot.com/api/index.php
?method=private.request.get&xRequest=123" \
-H "Authorization: Bearer YOUR_API_KEY"
// Response
{
"xRequest": 123,
"sTitle": "Cannot login",
"fOpen": true,
"xCategory": 5
}
Automation Rule
WHEN Status changes to "Escalated"
THEN Send Webhook
POST
Your External System
https://api.yourapp.com/webhook
Receiving ticket data
Webhooks

Push data when it matters

Configure webhooks through the automation system. When conditions are met, HelpSpot pushes data to your endpoint. Ticket created, status changed, SLA breached. You decide what triggers the action.

  • Triggered by automation rules
  • Dozens of conditions available
  • Send to any HTTP endpoint
  • Full ticket data in payload
Zero Code

5,000+ apps. No code required.

Point-and-click integrations with Slack, Microsoft Teams, Google Sheets, Salesforce, and thousands more. Set up in minutes with Zapier's visual builder. Free tier available.

  • Slack notifications for new tickets
  • Microsoft Teams integration
  • Google Sheets logging
  • CRM synchronization
HelpSpot
Zapier
Slack
Microsoft
Google
HubSpot
Real-Time Data

Pull customer context automatically

Live Lookup connects HelpSpot to your CRM, ERP, Active Directory, or any system with an API. When a ticket arrives, customer data appears automatically. No sync jobs, no stale data. Your external system stays the source of truth.

  • Connect to any system with API access
  • Data pulled in real-time (not synced)
  • Auto-populate custom fields
  • Your CRM stays the source of truth
Learn more about Live Lookup
Request Push

One-click ticket sync

Configure Request Push and a button appears on every ticket. Agents click it, add context, and ticket details are sent to your external system. Connect bug trackers, CRMs, project management tools, or any system that accepts HTTP requests.

  • Adds a Push button to every ticket
  • Agent adds context or comment
  • Posts to your configured endpoint
  • Perfect for bug tracker integration
#1247 Open

Login button not responding on mobile

Push to Jira
Pushed to Jira as BUG-892

Ready to simplify your support?

START 21-DAY FREE TRIAL CONTACT SALES →
query.sql
-- Custom report query
SELECT
xCategory,
COUNT(*) AS ticket_count,
AVG(fResolutionTime) AS avg_resolution
FROM HS_Request
WHERE dtGMTOpened >= '2024-01-01'
GROUP BY xCategory
ORDER BY ticket_count DESC;
Results (3 rows)
Category
Count
Avg Res.
Billing
847
4.2h
Technical
623
6.1h
Sales
412
2.8h
Self-Hosted Only

Direct database access

Self-hosted customers get full SQL access to their data. Connect BI tools like Tableau or Power BI, run custom queries, build advanced reports beyond what built-in reporting offers. Your data, your database, your rules.

  • Direct SQL access to your data
  • Connect Tableau, Power BI, or custom tools
  • MySQL and MS SQL Server supported
  • Complete control over your data

Authentication options

Connect to your identity provider or use built-in authentication.
F-01

SAML SSO

Azure AD, Google Workspace, Okta, or any SAML 2.0 provider. Single sign-on for your entire organization.

F-02

Active Directory / LDAP

Windows domain integration. Authenticate agents against your existing directory services.

F-03

Black Box API

Custom authentication for special needs. Authenticate against any system via HTTP.

F-04

Two-Factor Authentication

Built-in 2FA option. Add an extra layer of security without third-party tools.

Real examples from HelpSpot users

Customers have built complete solutions on top of HelpSpot. Here's what's possible.

Custom Dashboards

Build real-time dashboards for wall displays, executives, or team monitors using the API.

Mobile Apps

Custom mobile interfaces for field teams and on-the-go support.

Bug Tracker Sync

One-click Request Push API sends tickets to any bug tracker or external system.

CRM Integration

Pull customer context from any CRM via Live Lookup. Your data, in real-time.

Internal Tools

Employee portals, kiosks, and specialized interfaces for unique workflows.

Code Examples

See the API in action

Simple HTTP requests with JSON or XML responses. Works with any language or framework.

Get a ticket
GET
curl "https://yoursite.helpspot.com/api/index.php?method=private.request.get&xRequest=123" \
-H "Authorization: Bearer YOUR_API_KEY"
// Response
{
  "xRequest": 123,
  "sTitle": "Cannot login to my account",
  "fOpen": true,
  "xCategory": 5,
  "sFirstName": "John",
  "sLastName": "Smith",
  "sEmail": "john@example.com",
  "dtGMTOpened": "2024-01-15 14:32:00"
}
Create a ticket
POST
curl -X POST "https://yoursite.helpspot.com/api/index.php" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "method=private.request.create&
sFirstName=Jane&sLastName=Doe&
sEmail=jane@example.com&
tNote=I need help with billing&xCategory=3"
// Response
{
  "xRequest": 456,
  "accesskey": "abc123def456"
}
Update ticket status
POST
curl -X POST "https://yoursite.helpspot.com/api/index.php" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d "method=private.request.update&xRequest=123&
xStatus=2&tNote=Issue resolved via password reset"
// Response
{
  "xRequest": 123,
  "fOpen": false,
  "xStatus": 2
}
View Full API Documentation →

Developer FAQ

Common questions about the HelpSpot API and integrations.

Yes. We have reasonable rate limits in place to protect system performance. For typical integration use cases, you won't encounter them. If you need higher limits, contact us.

The API accepts form-encoded POST data and returns JSON responses. Simple, standard HTTP that works with any language or framework.

Yes. The same API is available for both HelpSpot Cloud and self-hosted installations. Self-hosted customers also get direct database access. See hosting options and pricing for details.

We don't maintain official SDKs, but the API is straightforward HTTP. Customers have built integrations in PHP, Python, JavaScript, Ruby, Go, and more without needing a dedicated library. AI coding tools like Claude and Cursor work great with HelpSpot too. Point them at the API docs and they can build integrations for you.

Webhooks are configured through the automation rules system. You set conditions (like "status changed to escalated") and an action to POST data to your endpoint. Full ticket data is included in the payload.

Yes, via Live Lookup. HelpSpot queries your external system in real-time when a ticket arrives, displaying customer context without needing to sync data.

Explore Core Features
Shared Inbox
Ticketing
Reporting
Automation
HelpSpot AI
Knowledge Base
Branding
API & Webhooks
INSTANT SETUP

Your inbox is waiting
to be tamed.

Join the teams who switched from chaos to HelpSpot's essential order. Download on-premise or start in the cloud today.

START 21-DAY FREE TRIAL WATCH PRODUCT TOUR →
NO CREDIT CARD REQUIRED
UNLIMITED TICKETS
90-DAY GUARANTEE