Deskpro

AI-powered help desk for tickets, knowledge base, and customer support workflows.

18 triggers45 searches47 actionsPollingAuth: API key

AI-assisted documentation33 min read

This documentation is compiled from our integration source code, internal specs for Deskpro, its official API documentation and anonymized requests logs we collect from our support team[2].

Open Deskpro on WEXTL →

Requirements

Before you set up the credential, make sure you have an active Deskpro account and an API access token from your account settings ready.[3]

Get your Deskpro credentials

API KeypasswordRequired
Create an API key via Deskpro’s admin interface, under Apps & Integrations -> API Keys.
[1]
subdomaintextRequired
Copy your subdomain is the URL shown in your browser’s address bar when you’re logged into your helpdesk. For example, deskpro.mycompany.com or mycompany.dekspro.com. Without https://.
[1]

Connect Deskpro in WEXTL

Log in to your WEXTL account, add the Deskpro node module to your workflow, and click Create new credential.
Optional: In the Credential name field, enter a name for the credential.
Enter the authentication credentials you copied from your Deskpro account, or follow the on-screen instructions to create the credential.
If prompted, authenticate your account and confirm access.
If you want to make changes to your credential in the future, follow the steps in Manage credentials →

Connecting Deskpro to WEXTL® — Video slide demonstrates how to integrate Deskpro in the WEXTL visual workflow builder.[4]

Video slide demonstrates how to integrate Deskpro in the WEXTL visual workflow builder.[4]

Notes

Credentials are org-scoped; share them with teammates from the Credentials picker on any of its nodes.For detailed information on connecting an application, see Connect an application →

Deskpro node modules

The list below is a reference of every Deskpro node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.

Each Deskpro node module below opens to reveal its input parameters, outputs, and connection requirements.

Watch Agent Chats MessagesTrigger

Output fields[3]

Field	Type
UUID	text
Person name	text
Message	text
Message text	text
Metadata	array
Date created	date
Timestamp	number
ID	number
Chat	number
Person	number

Watch Agent GroupsTrigger

Output fields[3]

Field	Type
Title	text
ID	number
Note	text
Is agent group	boolean
Sys name	text
Is enabled	boolean
Permissions	array
Department permissions	array
People	array

Watch Agent TeamTrigger

Output fields[3]

Field	Type
ID	number
Primary email	text
First name	text
Last name	text
Title prefix	text
Name	text
Display name	text
Is agent	boolean
Avatar	object
Default URL pattern	text
URL pattern	text
Base gravatar URL	text
Online	boolean
Online for chat	boolean

44other output fields

Watch AgentsTrigger

Output fields[3]

Field	Type
ID	number
Primary email	text
First name	text
Last name	text
Title prefix	text
Name	text
Display name	text
Is agent	boolean
Avatar	object
Default URL pattern	text
URL pattern	text
Base gravatar URL	text
Online	boolean
Online for chat	boolean

2other output fields

Watch Agents TeamTrigger

Output fields[3]

Field	Type
ID	number
Name	text
Avatar	object
Default URL pattern	text
URL pattern	text
Base gravatar URL	text
Agents	array

Watch Approval ResponseTrigger

Output fields[3]

Field	Type
ID	number
Name	text
Description	text
Required approvals	number
Required rejections	number
Type	number
Can approvers view subject	boolean
Actions on create	object
Version	number
Actions	array
Actions on partial approval response	object
Version	number
Actions	array
Actions on partial rejection response	object
Version	number
Actions	array
Actions on cancel	object
Version	number
Actions	array

6other output fields

Watch Approval TypesTrigger

Output fields[3]

Field	Type
Name	text
ID	number
Description	text
Is deleted	boolean

Watch ArticlesTrigger

Output fields[3]

Field	Type
Attachments	array
Labels	array
Title translations	object
Content translations	object
Title	text
Content	text
Comments	array
Status	text
Categories	array
Revisions	array
Date end	text

6other output fields

Watch Articles Custom FieldsTrigger

Output fields[3]

Field	Type
Title	text
Parent	text
Children	array

Watch ChatsTrigger

Output fields[3]

Field	Type
ID	number
Chat type	text
Is pinned	boolean
Date created	date
Date last message	date
Name	text
Admin	number
Departments	array
Agent teams	array
Agents	array

Watch Community TopicsTrigger

Output fields[3]

Field	Type
ID	number
Person	number
Language	number
Translated language	number
Slug	text
Title	text
Content	text
View count	number
Total rating	number
Num comments	number
Num ratings	number

17other output fields

Watch JobsTrigger

Output fields[3]

Field	Type
ID	number
Type	text
Status	text
Status code	text
Date touch	date
Date created	date
Date last try	date
Date next try	date
Num tries	number
Log summary	text
Log	text

2other output fields

Watch Personal Approval ResponseTrigger

Output fields[3]

Field	Type
Vote type	text
ID	number
Vote	number
Message	text
Created at	date
Approver	number
Approval	number

Watch TasksTrigger

Output fields[3]

Field	Type
ID	number
Tickets	array
Is completed	boolean
Title	text
Visibility	number
Date due	date
Date created	date
Date completed	date
Person	object
ID	number
Name	text
Assigned agent	object
ID	number
Name	text
Assigned department	object
ID	number
Title	text
User title	text
Is tickets enabled	boolean
Is chat enabled	boolean
Display order	number

3other output fields

Watch Ticket ApprovalTrigger

Output fields[3]

Field	Type
ID	number
Name	text
Description	text
Required approvals	number
Required rejections	number
Type	number
Can approvers view subject	boolean
Actions on create	object
Version	number
Actions	array
Actions on partial approval response	object
Version	number
Actions	array
Actions on partial rejection response	object
Version	number
Actions	array
Actions on cancel	object
Version	number
Actions	array

13other output fields

Watch TicketsTrigger

Output fields[3]

Field	Type
ID	number
Ref	text
Auth	text
Parent	text
Language	number
Brand	number
Department	number
Category	number
Priority	number
Workflow	number
Product	number

32other output fields

Watch User ChatTrigger

Output fields[3]

Field	Type
ID	number
Department	object
ID	number
Date created	date
Date last message	date
Status	text
Visitor name	text
Visitor email	text

Watch User Chat MessagesTrigger

Output fields[3]

Field	Type
ID	number
Author ID	number
Author type	text
Conversation ID	number
Author	number
Content	text
Is sys	boolean
Is user	boolean
Is HTML	boolean
Metadata	array
Date created	date

1other output field

Get a Community TopicAction

Input fields[3]

Field	Type
IDRequired	choice

Output fields[3]

Field	Type
ID	number
Person	number
Language	number
Translated language	number
Slug	text
Title	text
Content	text
View count	number
Total rating	number
Num comments	number
Num ratings	number

17other output fields

Get a JobAction

Input fields[3]

Field	Type
IDRequired	choice

Output fields[3]

Field	Type
ID	number
Type	text
Status	text
Status code	text
Date touch	date
Date created	date
Date last try	date
Date next try	date
Num tries	number
Log summary	text
Log	text

2other output fields

Get a TaskAction

Input fields[3]

Field	Type
IDRequired	choice

Output fields[3]

Field	Type
ID	number
Tickets	array
Is completed	boolean
Title	text
Visibility	number
Date due	date
Date created	date
Date completed	date
Person	object
ID	number
Name	text
Assigned agent	object
ID	number
Name	text
Assigned department	object
ID	number
Title	text
User title	text
Is tickets enabled	boolean
Is chat enabled	boolean
Display order	number

3other output fields

Get a TicketAction

Input fields[3]

Field	Type
IDRequired	choice

Output fields[3]

Field	Type
ID	number
Ref	text
Auth	text
Parent	text
Language	number
Brand	number
Department	number
Category	number
Priority	number
Workflow	number
Product	number

32other output fields

Get a User ChatAction

Input fields[3]

Field	Type
IDRequired	choice

Output fields[3]

Field	Type
ID	number
Department	object
ID	number
Date created	date
Date last message	date
Status	text
Visitor name	text
Visitor email	text

Get Agent Group CountAction

Output fields[3]

Field	Type
Count	number
ID	number
Value	text
Type	text
Title	text
Grouped by	text
Nested	array

Get Agent Team CountAction

Output fields[3]

Field	Type
Count	number
ID	number
Value	text
Type	text
Title	text
Grouped by	text
Nested	array

Get Agents CountAction

Output fields[3]

Field	Type
Count	number
ID	number
Value	text
Type	text
Title	text
Grouped by	text
Nested	array

Get Agents' Extended ModelsAction

Output fields[3]

Field	Type
ID	number
Primary email	text
First name	text
Last name	text
Title prefix	text
Name	text
Display name	text
Is agent	boolean
Avatar	object
Default URL pattern	text
URL pattern	text
Base gravatar URL	text
Online	boolean
Online for chat	boolean

7other output fields

Get an AgentAction

Input fields[3]

Field	Type
IDRequired	choice

Output fields[3]

Field	Type
ID	number
Primary email	text
First name	text
Last name	text
Title prefix	text
Name	text
Display name	text
Is agent	boolean
Avatar	object
Default URL pattern	text
URL pattern	text
Base gravatar URL	text
Online	boolean
Online for chat	boolean

2other output fields

Get an Agent ChatAction

Input fields[3]

Field	Type
IDRequired	choice

Output fields[3]

Field	Type
ID	number
Chat type	text
Is pinned	boolean
Date created	date
Date last message	date
Name	text
Admin	number
Departments	array
Agent teams	array
Agents	array

Get an Agent Chat MessageAction

Input fields[3]

Field	Type
ID	choice

Output fields[3]

Field	Type
UUID	text
Person name	text
Message	text
Message text	text
Metadata	array
Date created	date
Timestamp	date
ID	number
Chat	number
Person	number

Get an Agent GroupAction

Input fields[3]

Field	Type
IDRequired	choice

Output fields[3]

Field	Type
Title	text
ID	number
Note	text
Is agent group	boolean
Sys name	text
Is enabled	boolean
Permissions	array
Department permissions	array
People	array

Get an Agent TeamAction

Input fields[3]

Field	Type
IDRequired	choice
NameRequired	text
Avatar	text
Members	choice

Output fields[3]

Field	Type
ID	number
Name	text
Avatar	object
Default URL pattern	text
URL pattern	text
Base gravatar URL	text
Agents	array

Get an Approval TemplateAction

Input fields[3]

Field	Type
IDRequired	choice

Output fields[3]

Field	Type
ID	number
Name	text
Description	text
Required approvals	number
Required rejections	number
Type	number
Can approvers view subject	boolean
Actions on create	object
Version	number
Actions	array
Actions on partial approval response	object
Version	number
Actions	array
Actions on partial rejection response	object
Version	number
Actions	array
Actions on cancel	object
Version	number
Actions	array

6other output fields

Get an Approval Template CountAction

Output fields[3]

Field	Type
Count	number
ID	number
Value	text
Type	text
Title	text
Grouped by	text
Nested	array

Get an Approval TypeAction

Input fields[3]

Field	Type
IDRequired	choice

Output fields[3]

Field	Type
Name	text
ID	number
Description	text
Is deleted	boolean

Get an Approval Type CountAction

Output fields[3]

Field	Type
Count	number
ID	number
Value	text
Type	text
Title	text
Grouped by	text
Nested	array

Get an ArticleAction

Input fields[3]

Field	Type
Article IDRequired	choice

Output fields[3]

Field	Type
Attachments	array
Labels	array
Title translations	object
Content translations	object
Title	text
Content	text
Comments	array
Status	text
Categories	array
Revisions	array
Date end	text

6other output fields

Get Approval Responses CountAction

Input fields[3]

Field	Type
Ticket IDRequired	choice

Output fields[3]

Field	Type
Count	number
ID	number
Value	text
Type	text
Title	text
Grouped by	text
Nested	array

Get Article CountAction

Input fields[3]

Field	Type
IDs	choice
Author	text
Category	choice
Group By	choice
Status	choice
Hidden Status	choice
Period Created	choice
Period Last Comment	choice
Period Published	choice
Period Updated	choice
Order By	choice

Output fields[3]

Field	Type
Count	number
ID	number
Value	text
Type	text
Title	text
Grouped by	text
Nested	array

Get Article Custom FieldAction

Input fields[3]

Field	Type
IDRequired	choice

Output fields[3]

Field	Type
Title	text
Parent	text
Children	array

Get Person Approval Responses CountAction

Input fields[3]

Field	Type
Person IDRequired	choice

Output fields[3]

Field	Type
Count	number
ID	number
Value	text
Type	text
Title	text
Grouped by	text
Nested	array

Get Ticket Approval CountsAction

Input fields[3]

Field	Type
IDRequired	choice

Output fields[3]

Field	Type
Count	number
ID	number
Value	text
Type	text
Title	text
Grouped by	text
Nested	array

List Agent Chat MessagesSearch

Input fields[3]

Field	Type
ID	choice
Limit	number

Output fields[3]

Field	Type
UUID	text
Person name	text
Message	text
Message text	text
Metadata	array
Date created	date
Timestamp	number
ID	number
Chat	number
Person	number

List Agent ChatsSearch

Input fields[3]

Field	Type
IDs	choice
Limit	number

Output fields[3]

Field	Type
ID	number
Chat type	text
Is pinned	boolean
Date created	date
Date last message	date
Name	text
Admin	number
Departments	array
Agent teams	array
Agents	array

List Agent TeamsSearch

Input fields[3]

Field	Type
IDsRequired	choice
Limit to My Teams Only	boolean
Limit	number

Output fields[3]

Field	Type
ID	number
Name	text
Avatar	object
Default URL pattern	text
URL pattern	text
Base gravatar URL	text
Agents	array

List AgentsSearch

Input fields[3]

Field	Type
IDsRequired	choice
Is Deleted	number
Online	number
Online For Chat	number
Limit	number

Output fields[3]

Field	Type
ID	number
Primary email	text
First name	text
Last name	text
Title prefix	text
Name	text
Display name	text
Is agent	boolean
Avatar	object
Default URL pattern	text
URL pattern	text
Base gravatar URL	text
Online	boolean
Online for chat	boolean

2other output fields

List AgentsSearch

Input fields[3]

Field	Type
Limit	number

Output fields[3]

Field	Type
Integer	number

List Agents GroupsSearch

Input fields[3]

Field	Type
IDsRequired	choice
Limit	number

Output fields[3]

Field	Type
Title	text
ID	number
Note	text
Is agent group	boolean
Sys name	text
Is enabled	boolean
Permissions	array
Department permissions	array
People	array

List Approval ResponsesSearch

Input fields[3]

Field	Type
Ticket IDRequired	choice
Limit	number

Output fields[3]

Field	Type
Vote type	text
ID	number
Vote	number
Message	text
Created at	date
Approver	number
Approval	number

List Approval TemplatesSearch

Input fields[3]

Field	Type
IDsRequired	choice
Limit	number

Output fields[3]

Field	Type
ID	number
Name	text
Description	text
Required approvals	number
Required rejections	number
Type	number
Can approvers view subject	boolean
Actions on create	object
Version	number
Actions	array
Actions on partial approval response	object
Version	number
Actions	array
Actions on partial rejection response	object
Version	number
Actions	array
Actions on cancel	object
Version	number
Actions	array

6other output fields

List Approval TypesSearch

Input fields[3]

Field	Type
IDsRequired	choice
Is Deleted	boolean
Limit	number

Output fields[3]

Field	Type
Name	text
ID	number
Description	text
Is deleted	boolean

List ApprovalsSearch

Input fields[3]

Field	Type
ID	choice
TicketRequired	choice
Limit	number

Output fields[3]

Field	Type
Emails	array
Labels	array
Teams	array
Primary team	number
Agent data	object
Extension number	number
Available status	text
Agent calls enabled	boolean
Agent chat enabled	boolean
Agent can use forwarding	boolean
Forwarding number	text
Forwarding ring timeout	number
Forwarding number type	text
Forwarding logged out	boolean
Work status enabled	boolean
Public usergroups	array
Public agentgroups	array

List ArticlesSearch

Input fields[3]

Field	Type
IDs	choice
Author	text
Category	choice
Group By	choice
Status	choice
Hidden Status	choice
Period Created	choice
Period Last Comment	choice
Period Published	choice
Period Updated	choice
Order By	choice

1other input field

Output fields[3]

Field	Type
Attachments	array
Labels	array
Title translations	object
Content translations	object
Title	text
Content	text
Comments	array
Status	text
Categories	array
Revisions	array
Date end	text

6other output fields

List Articles Custom FieldsSearch

Input fields[3]

Field	Type
ID	choice
Limit	number

Output fields[3]

Field	Type
Title	text
Parent	text
Children	array

List Community TopicsSearch

Input fields[3]

Field	Type
IDsRequired	choice
Awaiting Validation	boolean
Status	choice
Hidden Status	choice
Status Category	array
Category	text
Forum	choice
Category	choice
Labels Mode	choice
Label	text
No Labels	boolean
Created From	date

5other input fields

Output fields[3]

Field	Type
ID	number
Person	number
Language	number
Translated language	number
Slug	text
Title	text
Content	text
View count	number
Total rating	number
Num comments	number
Num ratings	number

17other output fields

List JobsSearch

Input fields[3]

Field	Type
Limit	number

Output fields[3]

Field	Type
ID	number
Type	text
Status	text
Status code	text
Date touch	date
Date created	date
Date last try	date
Date next try	date
Num tries	number
Log summary	text
Log	text

2other output fields

List Person Approval ResponsesSearch

Input fields[3]

Field	Type
Person IDRequired	choice
Limit	number

Output fields[3]

Field	Type
Vote type	text
ID	number
Vote	number
Message	text
Created at	date
Approver	number
Approval	number

List TasksSearch

Input fields[3]

Field	Type
Task IDRequired	choice
Limit	number

Output fields[3]

Field	Type
ID	number
Tickets	array
Is completed	boolean
Title	text
Visibility	number
Date due	date
Date created	date
Date completed	date
Person	object
ID	number
Name	text
Assigned agent	object
ID	number
Name	text
Assigned department	object
ID	number
Title	text
User title	text
Is tickets enabled	boolean
Is chat enabled	boolean
Display order	number

3other output fields

List Team AgentsSearch

Input fields[3]

Field	Type
IDRequired	choice
Limit	number

Output fields[3]

Field	Type
ID	number
Primary email	text
First name	text
Last name	text
Title prefix	text
Name	text
Display name	text
Is agent	boolean
Avatar	object
Default URL pattern	text
URL pattern	text
Base gravatar URL	text
Online	boolean
Online for chat	boolean

44other output fields

List Ticket ApprovalsSearch

Input fields[3]

Field	Type
TicketRequired	choice
Limit	number

Output fields[3]

Field	Type
ID	number
Name	text
Description	text
Required approvals	number
Required rejections	number
Type	number
Can approvers view subject	boolean
Actions on create	object
Version	number
Actions	array
Actions on partial approval response	object
Version	number
Actions	array
Actions on partial rejection response	object
Version	number
Actions	array
Actions on cancel	object
Version	number
Actions	array

13other output fields

List TicketsSearch

Input fields[3]

Field	Type
Order By	choice
IDs	choice
Group Sort	choice
Filter	number
Labels	array
Label	text
Star	number
Status	number
Not Status	number
Date Status	text
Date Created	text
Date Resolved	text

14other input fields

Output fields[3]

Field	Type
ID	number
Ref	text
Auth	text
Parent	text
Language	number
Brand	number
Department	number
Category	number
Priority	number
Workflow	number
Product	number

32other output fields

List User Chat MessagesSearch

Input fields[3]

Field	Type
ID	choice
Agent Only	choice
Limit	number

Output fields[3]

Field	Type
ID	number
Author ID	number
Author type	text
Conversation ID	number
Author	number
Content	text
Is sys	boolean
Is user	boolean
Is HTML	boolean
Metadata	array
Date created	date

1other output field

List User ChatsSearch

Input fields[3]

Field	Type
IDs	choice
Status	choice
Date Created	text
Date Period	choice
Person	choice
Agent	choice
Department	choice
Brand	choice
Label	array
Label Value	text
Limit	number

Output fields[3]

Field	Type
ID	number
Department	object
ID	number
Date created	date
Date last message	date
Status	text
Visitor name	text
Visitor email	text

Approve an ApprovalAction

Input fields[3]

Field	Type
IDRequired	choice
Message	text

Output fields[3]

Field	Type
Vote type	text
ID	number
Vote	number
Message	text
Created at	date
Approver	number
Approval	number

Cancel an ApprovalAction

Input fields[3]

Field	Type
IDRequired	choice

Create a New Community TopicAction

Input fields[3]

Field	Type
TitleRequired	text
ContentRequired	text
PersonRequired	object
Person IDRequired	choice
Name	text
Email	email
ForumRequired	choice
Status	text
Labels	array
Label	text
Fields	object
Priority	text
Context	text
User Feedback	text
Accessibility Importance	text
Platforms	array
Expected Date	date
Plan Status	text
Related Areas	array
Difficulty Level	text
Review Date	date
Is Reviewed	boolean

Output fields[3]

Field	Type
ID	number
Person	number
Language	number
Translated language	number
Slug	text
Title	text
Content	text
View count	number
Total rating	number
Num comments	number
Num ratings	number

17other output fields

Create a TaskAction

Input fields[3]

Field	Type
TitleRequired	text
PersonRequired	choice
Date Due	date
Visibility	choice
Assigned Agent	choice
Assigned Agent Team	choice
Assigned Department	choice
Date Completed	date
Is Completed	boolean
Ticket	choice
Tickets	choice

1other input field

Output fields[3]

Field	Type
ID	number
Tickets	array
Is completed	boolean
Title	text
Visibility	number
Date due	date
Date created	date
Date completed	date
Person	object
ID	number
Name	text
Assigned agent	object
ID	number
Name	text
Assigned department	object
ID	number
Title	text
User title	text
Is tickets enabled	boolean
Is chat enabled	boolean
Display order	number

3other output fields

Create a TicketAction

Input fields[3]

Field	Type
SubjectRequired	text
DepartmentRequired	choice
LanguageRequired	choice
PersonRequired	object
EmailRequired	email
Name	text
Status	choice
UrgencyRequired	number
Agent Team	choice
Organization	choice
Is Hold	boolean
Labels	array
Label	text
CC	array

5other input fields

Output fields[3]

Field	Type
ID	number
Ref	text
Auth	text
Parent	text
Language	number
Brand	number
Department	number
Category	number
Priority	number
Workflow	number
Product	number

32other output fields

Create a Ticket ApprovalAction

Input fields[3]

Field	Type
IDRequired	choice

Output fields[3]

Field	Type
ID	number
Name	text
Description	text
Required approvals	number
Required rejections	number
Type	number
Can approvers view subject	boolean
Actions on create	object
Version	number
Actions	array
Actions on partial approval response	object
Version	number
Actions	array
Actions on partial rejection response	object
Version	number
Actions	array
Actions on cancel	object
Version	number
Actions	array

13other output fields

Create a User ChatAction

Input fields[3]

Field	Type
SubjectRequired	text
PersonRequired	object
IDRequired	choice
Name	text
EmailRequired	email
Person Email	email
AgentRequired	object
IDRequired	choice
Name	text
EmailRequired	email
Email Validated	boolean
Fields	object
Field 2	object
Field 3	object
Field 7	object
Field 8	object
Field 9	object
Chat Department	choice
Rating Comment	text
Rating Overall	boolean

Output fields[3]

Field	Type
ID	number
Department	object
ID	number
Date created	date
Date last message	date
Status	text
Visitor name	text
Visitor email	text

Create an Agent ChatAction

Input fields[3]

Field	Type
ParticipantRequired	choice
TypeRequired	choice

Output fields[3]

Field	Type
ID	number
Chat type	text
Is pinned	boolean
Date created	date
Date last message	date
Name	text
Admin	number
Departments	array
Agent teams	array
Agents	array

Create an Agent Chat MessageAction

Input fields[3]

Field	Type
ID	choice
MessageRequired	text
UUIDRequired	text

Output fields[3]

Field	Type
UUID	text
Person name	text
Message	text
Message text	text
Metadata	array
Date created	date
Timestamp	date
ID	number
Chat	number
Person	number

Create an Agent TeamAction

Input fields[3]

Field	Type
NameRequired	text
Avatar	text
Members	choice

Output fields[3]

Field	Type
ID	number
Primary email	text
First name	text
Last name	text
Title prefix	text
Name	text
Display name	text
Is agent	boolean
Avatar	object
Default URL pattern	text
URL pattern	text
Base gravatar URL	text
Online	boolean
Online for chat	boolean

2other output fields

Create an Approval TemplateAction

Input fields[3]

Field	Type
TypeRequired	text
NameRequired	text
Required ApprovalsRequired	number
Required RejectionsRequired	number
Can Approvers View SubjectRequired	boolean
Can Choose ApproversRequired	boolean
Description	text
Actions on Create	text
Actions on Partial Approval Response	text
Actions on Partial Rejection Response	text
Actions on Cancel	text

2other input fields

Output fields[3]

Field	Type
ID	number
Name	text
Description	text
Required approvals	number
Required rejections	number
Type	number
Can approvers view subject	boolean
Actions on create	object
Version	number
Actions	array
Actions on partial approval response	object
Version	number
Actions	array
Actions on partial rejection response	object
Version	number
Actions	array
Actions on cancel	object
Version	number
Actions	array

6other output fields

Create an Approval TypeAction

Input fields[3]

Field	Type
NameRequired	text
Description	text
Is Deleted	boolean

Output fields[3]

Field	Type
Name	text
ID	number
Description	text
Is deleted	boolean

Create an ArticleAction

Input fields[3]

Field	Type
TitleRequired	text
ContentRequired	text
StatusRequired	choice
Title Translations	array
Content Translations	array
Fields	array
Fields (Choice and Date)	array
Person	object
ID	choice
Name	text
Email	email
Field ID	text
Key	text
Language	choice
Content Input Type	choice
Categories	choice

1other input field

Output fields[3]

Field	Type
Attachments	array
Labels	array
Title translations	object
Content translations	object
Title	text
Content	text
Comments	array
Status	text
Categories	array
Revisions	array
Date end	text

6other output fields

Create an Article Custom FieldAction

Input fields[3]

Field	Type
TitleRequired	text
DescriptionRequired	text
Handler ClassRequired	text
Parent IDRequired	text
Default ValueRequired	text
Is EnabledRequired	boolean
OptionsRequired	text
AliasesRequired	text
Is User EnabledRequired	boolean
Is Agent FieldRequired	boolean
Display OrderRequired	number

Output fields[3]

Field	Type
Title	text
Parent	text
Children	array

Create User Chat MessagesAction

Input fields[3]

Field	Type
Chat ID	choice
ContentRequired	text
Author	object
ID	text
Name	text
Email	email
Field ID	text
Key	text
Is User	boolean
Person Name	text
Blob	text

Output fields[3]

Field	Type
ID	number
Author ID	number
Author type	text
Conversation ID	number
Author	number
Content	text
Is sys	boolean
Is user	boolean
Is HTML	boolean
Metadata	array
Date created	date

1other output field

Delete a Community TopicAction

Input fields[3]

Field	Type
IDRequired	choice

Delete a TaskAction

Input fields[3]

Field	Type
IDRequired	choice

Delete a TicketAction

Input fields[3]

Field	Type
IDRequired	choice

Delete a User ChatAction

Input fields[3]

Field	Type
IDRequired	choice

Delete an AgentAction

Input fields[3]

Field	Type
IDRequired	choice

Delete an Agent ChatAction

Input fields[3]

Field	Type
IDRequired	choice

Delete an Agent Chat MessageAction

Input fields[3]

Field	Type
ID	choice

Delete an Agent GroupAction

Input fields[3]

Field	Type
IDRequired	choice

Delete an Agent TeamAction

Input fields[3]

Field	Type
IDRequired	choice

Delete an Approval TemplateAction

Input fields[3]

Field	Type
IDRequired	choice

Delete an Approval TypeAction

Input fields[3]

Field	Type
IDRequired	choice

Delete an ArticleAction

Input fields[3]

Field	Type
Article IDRequired	choice

Delete Article Custom FieldsAction

Input fields[3]

Field	Type
IDRequired	choice

Download an Article as PDFAction

Input fields[3]

Field	Type
Article IDRequired	choice

Make an API Calluniversal

Input fields[3]

Field	Type
MethodRequired	choice
Headers	array
Header	object
Query String	array
Parameter	object
Body	text

Output fields[3]

Field	Type
Body	text
Headers	object
Status code	number

Rate an ArticleAction

Input fields[3]

Field	Type
Article IDRequired	choice
UpvoteRequired	choice

Reject an ApprovalAction

Input fields[3]

Field	Type
IDRequired	choice
Message	text

Output fields[3]

Field	Type
Vote type	text
ID	number
Vote	number
Message	text
Created at	date
Approver	number
Approval	number

Set an Article IconAction

Input fields[3]

Field	Type
IDRequired	choice
URNRequired	text
StyleRequired	text
ColorRequired	text

Set an Article Splash ImageAction

Input fields[3]

Field	Type
IDRequired	choice

Update a Community TopicAction

Input fields[3]

Field	Type
IDRequired	choice
Title	text
Content	text
Person	object
Person ID	choice
Name	text
Email	email
Forum	choice
Status	text
Labels	array
Label	text
Fields	object
Priority	text
Context	text
User Feedback	text
Accessibility Importance	text
Platforms	array
Expected Date	date
Plan Status	text
Related Areas	array
Difficulty Level	text
Review Date	date
Is Reviewed	boolean

Output fields[3]

Field	Type
ID	number
Person	number
Language	number
Translated language	number
Slug	text
Title	text
Content	text
View count	number
Total rating	number
Num comments	number
Num ratings	number

17other output fields

Update a TaskAction

Input fields[3]

Field	Type
IDRequired	choice
Title	text
Person	choice
Date Due	date
Visibility	choice
Assigned Agent	choice
Assigned Agent Team	choice
Assigned Department	choice
Date Completed	date
Is Completed	boolean
Ticket	choice

2other input fields

Output fields[3]

Field	Type
ID	number
Tickets	array
Is completed	boolean
Title	text
Visibility	number
Date due	date
Date created	date
Date completed	date
Person	object
ID	number
Name	text
Assigned agent	object
ID	number
Name	text
Assigned department	object
ID	number
Title	text
User title	text
Is tickets enabled	boolean
Is chat enabled	boolean
Display order	number

3other output fields

Update a TicketAction

Input fields[3]

Field	Type
IDRequired	choice
Subject	text
Department	choice
Language	choice
Person	object
Email	email
Name	text
Status	choice
Urgency	number
Agent Team	choice
Organization	choice
Is Hold	boolean
Labels	array
Label	text

6other input fields

Output fields[3]

Field	Type
ID	number
Ref	text
Auth	text
Parent	text
Language	number
Brand	number
Department	number
Category	number
Priority	number
Workflow	number
Product	number

32other output fields

Update a User ChatAction

Input fields[3]

Field	Type
IDRequired	choice
Subject	text
Person	object
ID	choice
Name	text
Email	email
Person Email	email
Agent	object
ID	text
Name	text
Email	email
Email Validated	boolean
Fields	object
Field 2	object
Field 3	object
Field 7	object
Field 8	object
Field 9	object
Chat Department	text
Rating Comment	text
Rating Overall	boolean

Output fields[3]

Field	Type
ID	number
Department	object
ID	number
Date created	date
Date last message	date
Status	text
Visitor name	text
Visitor email	text

Update an Agent ChatAction

Input fields[3]

Field	Type
IDRequired	choice
Participant	choice
Type	choice

Output fields[3]

Field	Type
ID	number
Chat type	text
Is pinned	boolean
Date created	date
Date last message	date
Name	text
Admin	number
Departments	array
Agent teams	array
Agents	array

Update an Agent Chat MessageAction

Input fields[3]

Field	Type
ID	choice
MessageRequired	text
UUIDRequired	text

Output fields[3]

Field	Type
UUID	text
Person name	text
Message	text
Message text	text
Metadata	array
Date created	date
Timestamp	date
ID	number
Chat	number
Person	number

Update an Agent ProfileAction

Input fields[3]

Field	Type
Available Status	choice
Agent Calls Enabled	boolean
Agent Chat Enabled	boolean
Agent Can Use Forwarding	boolean
Voicemail Asset	text
Forwarding Number	text
Forwarding Ring Timeout	number
Forwarding Logged Out	boolean
Login Status	choice

Update an Agent TeamAction

Input fields[3]

Field	Type
IDRequired	choice
Name	text
Avatar	text
Members	choice

Output fields[3]

Field	Type
ID	number
Name	text
Avatar	object
Default URL pattern	text
URL pattern	text
Base gravatar URL	text
Agents	array

Update an Approval TemplateAction

Input fields[3]

Field	Type
IDRequired	choice
Type	text
Name	text
Required Approvals	number
Required Rejections	number
Can Approvers View Subject	boolean
Can Choose Approvers	boolean
Description	text
Actions on Create	text
Actions on Partial Approval Response	text
Actions on Partial Rejection Response	text

3other input fields

Output fields[3]

Field	Type
ID	number
Name	text
Description	text
Required approvals	number
Required rejections	number
Type	number
Can approvers view subject	boolean
Actions on create	object
Version	number
Actions	array
Actions on partial approval response	object
Version	number
Actions	array
Actions on partial rejection response	object
Version	number
Actions	array
Actions on cancel	object
Version	number
Actions	array

6other output fields

Update an Approval TypeAction

Input fields[3]

Field	Type
IDRequired	choice
Name	text
Description	text
Is Deleted	boolean

Output fields[3]

Field	Type
Name	text
ID	number
Description	text
Is deleted	boolean

Update an ArticleAction

Input fields[3]

Field	Type
Article IDRequired	choice
Title	text
Content	text
Status	choice
Title Translations	array
Content Translations	array
Fields	array
Fields (Choice and Date)	array
Person	object
ID	choice
Name	text
Email	email
Field ID	text
Key	text
Language	choice
Content Input Type	choice

2other input fields

Output fields[3]

Field	Type
Attachments	array
Labels	array
Title translations	object
Content translations	object
Title	text
Content	text
Comments	array
Status	text
Categories	array
Revisions	array
Date end	text

6other output fields

Update Article Custom FieldsAction

Input fields[3]

Field	Type
IDRequired	choice
Title	text
Description	text
Handler Class	text
Parent ID	text
Default Value	text
Is Enabled	boolean
Options	text
Aliases	text
Is User Enabled	boolean
Is Agent Field	boolean

1other input field

Output fields[3]

Field	Type
Title	text
Parent	text
Children	array

Upload Article Splash ImageAction

Input fields[3]

Field	Type
IDRequired	choice

Templates

Look for Deskpro templates in the WEXTL template library.

Browse templates →

Explore alternative apps

More apps in Support category →

References

WEXTL® Deskpro Source Code connector implementation.
Our users use cases and automations.
Official API Documentation for Deskpro.
WEXTL® visual workflow builder data.

Last updated: Jul 23, 2026 22:39

How we write our apps documentation

How we compile these docs — sources, AI's role, and how we verify.