Social Media & CRM Endpoints

Social Media, CRM & Notifications

FacebookDetails

Manage Facebook integration configurations for creating tickets from Messenger messages, posts, ratings, and ads.

GET /FacebookDetails

Summary: List of FacebookDetails

Returns multiple FacebookDetails. Requires authentication.

Parameter	Type	Description
page_id	string	Filter by Facebook page ID

POST /FacebookDetails

Create or update FacebookDetails.

Request Body: Array of FacebookDetails

Key fields:

Field	Type	Description
id	integer	Record ID
user_id	string	Facebook user ID
page_id	string	Facebook page ID
page_name	string	Facebook page name
authorized	boolean	Whether the connection is authorized
create_messenger_tickets	boolean	Auto-create tickets from Messenger messages
messenger_ticket_type	integer	Ticket type ID for Messenger tickets
messenger_user	integer	Default user ID for Messenger tickets
reopen_messenger_tickets	boolean	Reopen existing tickets on new messages
create_post_tickets	boolean	Auto-create tickets from page posts
post_ticket_type	integer	Ticket type ID for post tickets
post_user	integer	Default user ID for post tickets
days_after_post	integer	Days after post to stop monitoring
include_word_list	array	Keywords that trigger ticket creation
exclude_word_list	array	Keywords that exclude ticket creation
ratings_create_tickets	boolean	Auto-create tickets from ratings
ratings_ticket_type	integer	Ticket type ID for rating tickets
ratings_only_negative	boolean	Only create tickets for negative ratings
ads_create_tickets	boolean	Auto-create tickets from ads
linked_instagram_account	string	Linked Instagram account

GET /FacebookDetails/{id}

Summary: Get one FacebookDetails

Returns a single FacebookDetails instance. Requires authentication.

Parameter	Type	Description
id	integer (path, required)	FacebookDetails ID
includedetails	boolean	Include extra detail objects

DELETE /FacebookDetails/{id}

Delete a FacebookDetails record.

Parameter	Type	Description
id	integer (path, required)	FacebookDetails ID

---

TwitterDetails

Manage Twitter/X integration configurations for creating tickets from direct messages and mentions.

GET /TwitterDetails

Summary: List of TwitterDetails

Returns multiple TwitterDetails. Requires authentication.

Parameter	Type	Description
account_id	string	Filter by Twitter account ID

POST /TwitterDetails

Create or update TwitterDetails.

Request Body: Array of TwitterDetails

Key fields:

Field	Type	Description
id	integer	Record ID
screen_name	string	Twitter screen name
user_id	string	Twitter user ID
authorized	boolean	Whether the connection is authorized
create_direct_message_tickets	boolean	Auto-create tickets from DMs
direct_message_ticket_type	integer	Ticket type ID for DM tickets
direct_message_user	integer	Default user ID for DM tickets
reopen_direct_message_tickets	boolean	Reopen existing tickets on new DMs
create_mention_tickets	boolean	Auto-create tickets from mentions
mention_ticket_type	integer	Ticket type ID for mention tickets
mention_user	integer	Default user ID for mention tickets
days_after_mention	integer	Days after mention to stop monitoring
include_word_list	array	Keywords that trigger ticket creation
exclude_word_list	array	Keywords that exclude ticket creation
direct_message_create_users	boolean	Auto-create users from DM senders
mention_create_users	boolean	Auto-create users from mention authors

GET /TwitterDetails/{id}

Summary: Get one TwitterDetails

Returns a single TwitterDetails instance. Requires authentication.

Parameter	Type	Description
id	integer (path, required)	TwitterDetails ID
includedetails	boolean	Include extra detail objects

DELETE /TwitterDetails/{id}

Delete a TwitterDetails record.

Parameter	Type	Description
id	integer (path, required)	TwitterDetails ID

---

GoogleBusinessDetails

Manage Google Business integration configurations.

GET /GoogleBusinessDetails

Returns a list of GoogleBusinessDetails.

POST /GoogleBusinessDetails

Create or update GoogleBusinessDetails.

Request Body: Array of GoogleBusinessDetails

Key fields:

Field	Type	Description
id	integer	Record ID
connectionname	string	Display name for the connection
authorized	boolean	Whether the connection is authorized
enabled	boolean	Whether the integration is enabled
account	string	Google Business account ID
location	string	Google Business location ID
account_name	string	Google Business account name
location_name	string	Google Business location name

GET /GoogleBusinessDetails/{id}

Returns a single GoogleBusinessDetails instance.

Parameter	Type	Description
id	integer (path, required)	GoogleBusinessDetails ID

DELETE /GoogleBusinessDetails/{id}

Delete a GoogleBusinessDetails record.

Parameter	Type	Description
id	integer (path, required)	GoogleBusinessDetails ID

---

WordpressDetails

Manage WordPress.com integration configurations (OAuth-based).

GET /WordpressDetails

Returns a list of WordpressDetails.

POST /WordpressDetails

Create or update WordpressDetails.

Request Body: Array of WordpressDetails

Key fields:

Field	Type	Description
id	integer	Record ID
connectionname	string	Display name for the connection
authorized	boolean	Whether the connection is authorized
enabled	boolean	Whether the integration is enabled
blogid	string	WordPress blog ID
blogurl	string	WordPress blog URL

GET /WordpressDetails/{id}

Returns a single WordpressDetails instance.

Parameter	Type	Description
id	integer (path, required)	WordpressDetails ID

DELETE /WordpressDetails/{id}

Delete a WordpressDetails record.

Parameter	Type	Description
id	integer (path, required)	WordpressDetails ID

---

WordpressOrgDetails

Manage WordPress.org (self-hosted) integration configurations.

GET /WordpressOrgDetails

Returns a list of WordpressOrgDetails.

POST /WordpressOrgDetails

Create or update WordpressOrgDetails.

Request Body: Array of WordpressOrgDetails

Key fields:

Field	Type	Description
id	integer	Record ID
connectionname	string	Display name for the connection
username	string	WordPress username
enabled	boolean	Whether the integration is enabled
blogurl	string	WordPress blog URL
import_this_tag	integer	Tag ID to import posts by
post_status_to_import	string	Post status filter for import
use_custom_endpoint	boolean	Use a custom REST endpoint
custom_endpoint	string	Custom endpoint URL
default_faqlist	integer	Default FAQ list ID for imported articles
importcategories	boolean	Import WordPress categories

GET /WordpressOrgDetails/{id}

Returns a single WordpressOrgDetails instance.

Parameter	Type	Description
id	integer (path, required)	WordpressOrgDetails ID

DELETE /WordpressOrgDetails/{id}

Delete a WordpressOrgDetails record.

Parameter	Type	Description
id	integer (path, required)	WordpressOrgDetails ID

---

ConfluenceDetails

Manage Atlassian Confluence integration configurations.

GET /ConfluenceDetails

Returns a list of ConfluenceDetails.

POST /ConfluenceDetails

Create or update ConfluenceDetails.

Request Body: Array of ConfluenceDetails

Key fields:

Field	Type	Description
id	integer	Record ID
name	string	Connection name
url	string	Confluence instance URL
username	string	Confluence username
enabled	boolean	Whether the integration is enabled
allow_webhooks	boolean	Allow incoming webhooks
webhook_authentication	integer	Webhook authentication type
faq_links	array	Linked FAQ list configurations

GET /ConfluenceDetails/{id}

Returns a single ConfluenceDetails instance.

Parameter	Type	Description
id	integer (path, required)	ConfluenceDetails ID

DELETE /ConfluenceDetails/{id}

Delete a ConfluenceDetails record.

Parameter	Type	Description
id	integer (path, required)	ConfluenceDetails ID

---

JiraDetails

Manage Atlassian Jira integration configurations.

GET /JiraDetails

Returns a list of JiraDetails.

POST /JiraDetails

Create or update JiraDetails.

Request Body: Array of JiraDetails

Key fields:

Field	Type	Description
id	integer	Record ID
name	string	Connection name
instance_url	string	Jira instance URL
username	string	Jira username
defaulttickettype	integer	Default HaloPSA ticket type for Jira issues
defaultuser	integer	Default user ID for imported Jira issues
issuetype	string	Jira issue type to sync
status_mappings	array	Status mapping between Jira and HaloPSA
priority_mappings	array	Priority mapping between Jira and HaloPSA
jirafield_mappings	array	Custom field mappings
allow_webhooks	boolean	Allow incoming webhooks from Jira
visibletoendusers	boolean	Make synced tickets visible to end users

GET /JiraDetails/{id}

Returns a single JiraDetails instance.

Parameter	Type	Description
id	integer (path, required)	JiraDetails ID

DELETE /JiraDetails/{id}

Delete a JiraDetails record.

Parameter	Type	Description
id	integer (path, required)	JiraDetails ID

---

AzureDevOps

Manage Azure DevOps integration configurations.

GET /AzureDevOpsDetails

Returns a list of AzureDevOpsDetails.

POST /AzureDevOpsDetails

Create or update AzureDevOpsDetails.

Request Body: Array of AzureDevOpsDetails

Key fields:

Field	Type	Description
id	integer	Record ID
name	string	Connection name
instance_url	string	Azure DevOps instance URL
enableintegrator	boolean	Enable the integration
ticket_type	integer	Default HaloPSA ticket type
ticket_user	integer	Default user ID for synced work items
sync_status	boolean	Sync status between systems
sync_priority	boolean	Sync priority between systems
sync_attachments	boolean	Sync attachments
sync_summary	boolean	Sync summary/title
sync_area_path	boolean	Sync Azure DevOps area path
sync_iteration_path	boolean	Sync Azure DevOps iteration path
status_mappings	array	Status mappings
priority_mappings	array	Priority mappings
areapath_mappings	array	Area path mappings
fields_to_sync_list	array	List of fields to synchronize
enablepipelines	boolean	Enable pipeline integration
lastsyncdate	datetime	Date/time of last successful sync
lastsyncerror	string	Last sync error message

GET /AzureDevOpsDetails/{id}

Summary: Get one AzureDevOpsDetails

Returns a single AzureDevOpsDetails instance. Requires authentication.

Parameter	Type	Description
id	integer (path, required)	AzureDevOpsDetails ID
includedetails	boolean	Include extra detail objects

DELETE /AzureDevOpsDetails/{id}

Delete an AzureDevOpsDetails record.

Parameter	Type	Description
id	integer (path, required)	AzureDevOpsDetails ID

---

SharePoint

GET /SharePoint/Get

Returns SharePoint integration details.

---

Opps

CRM Opportunities — stored as a special domain of the Faults/Tickets data model. Opportunities are prospects or sales pipeline records.

GET /Opportunities

Summary: List of Faults (Opportunities)

Returns multiple Opportunities. Requires authentication.

Response Schema: Faults_View

Field	Type	Description
page_no	integer	Current page number
page_size	integer	Page size
record_count	integer	Total record count
tickets	array	Array of Faults/Opportunity records

Key query parameters:

Parameter	Type	Description
advanced_search	string	Advanced search expression
agent	string	Array of agent IDs (comma-separated)
agent_id	integer	Filter by agent ID
client_id	integer	Filter by client ID
client_ids	string	Array of client IDs
status_id	integer	Filter by status ID
status	string	Array of status IDs
requesttype_id	integer	Filter by request type ID
requesttype	string	Array of request type IDs
itil_requesttype_id	integer	Filter by ITIL request type ID
priority	string	Array of priority IDs
category_1	string	Array of category 1 IDs
category_2	string	Array of category 2 IDs
category_3	string	Array of category 3 IDs
category_4	string	Array of category 4 IDs
search	string	Full-text search string
search_details	string	Search within ticket details
search_summary	string	Search within ticket summary
search_oppcompanyname	string	Search by opportunity company name
search_oppcontactname	string	Search by opportunity contact name
search_oppemailaddress	string	Search by opportunity email address
open_only	boolean	Return only open opportunities
closed_only	boolean	Return only closed opportunities
count	integer	Number of records to return
page_no	integer	Page number (for pagination)
page_size	integer	Page size (max 100)
pageinate	boolean	Enable pagination
order	string	Primary sort field
orderdesc	boolean	Sort descending on primary order