DeskDirector

  • Reference

DeskDirector automates and accelerates ticket-based workflows between Users and Techs working IT services. The DeskDirector connector is a deep and powerful integration into our rich ticketing platform. All phases of a ticket’s life cycle can be automated and enhanced for superior service experience.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name DeskDirector Support
URL https://support.deskdirector.com
Email support@deskdirector.com
Connector Metadata
Publisher DeskDirector Limited
Website https://www.deskdirector.com
Privacy policy https://www.deskdirector.com/privacy-policy
Categories IT Operations;Productivity

DeskDirector is a user centered, cloud-based ticketing system for I.T. support and general service management. DeskDirector is extremely configurable out-of-the box. But when you want even more service options, you can extend DeskDirector’s great service functionality and service reach, with this extensively featured connector.

Prerequisites

You will need an active DeskDirector subscription with flow connector feature in order to use the DeskDirector Connector, you can read about our pricing here.

How to get credentials

When setting up a new connection, you will be asked to provide an API key, the key can be generated or retrived from your admin portal, see documentation here.

Get started with your connector

Read our step-by-step guide on getting started with the DeskDirector connector here.

FAQ

Read the FAQ from our knowledge base here.

Creating a connection

The connector supports the following authentication types:
Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
Site Host string Root site URL (Example: support.deskdirector.com) True
API Key securestring DeskDirector API Key True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Create a contact

This operation creates a contact.
Create a ticket

This operation creates a ticket.
Create an email from template

This operation generates an HTML document from a dynamic email template. Dynamic email templates can be managed in your admin portal.
Create ticket tasks

This operation creates ticket tasks from templates or scratch.
Find companies

Find companies by keywords or filters.
Find contacts

Find contacts by keywords or filters.
Find members

Find members by keywords or filters.
Find ticket task templates

Find ticket task templates by keywords or filters.
Find tickets

Find tickets by keywords or filters.
Find user groups

Find user groups by keywords or filters.
Get a chat session

This operation return a chat session's details.
Get a company

This operation returns a company's details.
Get a contact

This operation returns a contact's details.
Get a form result

This operation returns the form entry by the form result ID.
Get a form result V2 (Preview)

This operation returns the form entry by the form result ID.
Get a member

This operation returns a member's details.
Get a ticket

This operation returns a ticket's details.
Get ticket tasks

This operation return all ticket task lists.
Invite users to chat

This operation invites users to a chat session.
Respond to an Advanced Event

Respond to an Advanced Event.
Run an advanced action

An advanced action is an Azure Function provides some extra functionalities for the connector.
Send a notification to a contact

This operation sends a notification to a contact in the client portal.
Send a notification to a member

This operation sends a notification to a member in the tech portal.
Send a system message in chat

This operation sends a system message in a chat session.
Update a ticket

This operation updates a ticket.

Create a contact

Operation ID:
CreateContact

This operation creates a contact.

Parameters

Name Key Required Type Description
req
 req True dynamic

Returns

The outputs of this operation are dynamic.

Create a ticket

Operation ID:
CreateTicket

This operation creates a ticket.

Parameters

Name Key Required Type Description
Request Type
 requestTypeId True integer

Specify the request type.
req
 req True dynamic

Returns

The outputs of this operation are dynamic.

Create an email from template

Operation ID:
GenerateEmailFromTemplate

This operation generates an HTML document from a dynamic email template. Dynamic email templates can be managed in your admin portal.

Parameters

Name Key Required Type Description
Template
 emailTemplateId True string

Specify the email template.
req
 req True dynamic

Returns

The outputs of this operation are dynamic.

Create ticket tasks

Operation ID:
CreateTicketTasks

This operation creates ticket tasks from templates or scratch.

Parameters

Name Key Required Type Description
Ticket
 ticketId True integer

Specify the ID of the ticket.
req
 req True dynamic

Returns

The outputs of this operation are dynamic.

Find companies

Operation ID:
FindCompanies

Find companies by keywords or filters.

Parameters

Name Key Required Type Description
req
 req True dynamic

Returns

The outputs of this operation are dynamic.

Find contacts

Operation ID:
FindContacts

Find contacts by keywords or filters.

Parameters

Name Key Required Type Description
req
 req True dynamic

Returns

The outputs of this operation are dynamic.

Find members

Operation ID:
FindMembers

Find members by keywords or filters.

Parameters

Name Key Required Type Description
req
 req True dynamic

Returns

The outputs of this operation are dynamic.

Find ticket task templates

Operation ID:
FindTicketTaskTemplates

Find ticket task templates by keywords or filters.

Parameters

Name Key Required Type Description
req
 req True dynamic

Returns

The outputs of this operation are dynamic.

Find tickets

Operation ID:
FindTickets

Find tickets by keywords or filters.

Parameters

Name Key Required Type Description
req
 req True dynamic

Returns

The outputs of this operation are dynamic.

Find user groups

Operation ID:
FindUserGroups

Find user groups by keywords or filters.

Parameters

Name Key Required Type Description
req
 req True dynamic

Returns

The outputs of this operation are dynamic.

Get a chat session

Operation ID:
GetChatSession

This operation return a chat session's details.

Parameters

Name Key Required Type Description
Session
 sessionId True string

Specify the chat session ID.

Returns

The outputs of this operation are dynamic.

Get a company

Operation ID:
GetCompany

This operation returns a company's details.

Parameters

Name Key Required Type Description
Company ID
 companyId True integer

Specify the company's ID.

Returns

The outputs of this operation are dynamic.

Get a contact

Operation ID:
GetContact

This operation returns a contact's details.

Parameters

Name Key Required Type Description
Contact ID
 contactId True integer

Specify the contact's ID.

Returns

The outputs of this operation are dynamic.

Get a form result

Operation ID:
GetFormResult

This operation returns the form entry by the form result ID.

Parameters

Name Key Required Type Description
Form
 formId True integer

Specify the form.
Result
 resultId True integer

Specify the result ID.

Returns

The outputs of this operation are dynamic.

Get a form result V2 (Preview)

Operation ID:
GetFormResult_V2

This operation returns the form entry by the form result ID.

Parameters

Name Key Required Type Description
Form
 formId True integer

Specify the form.
Result
 resultId True integer

Specify the result ID.

Returns

The outputs of this operation are dynamic.

Get a member

Operation ID:
GetMember

This operation returns a member's details.

Parameters

Name Key Required Type Description
Member ID
 memberId True integer

Specify the member's ID.

Returns

The outputs of this operation are dynamic.

Get a ticket

Operation ID:
GetTicket

This operation returns a ticket's details.

Parameters

Name Key Required Type Description
Ticket
 ticketId True integer

Specify the ID of the ticket.

Returns

The outputs of this operation are dynamic.

Get ticket tasks

Operation ID:
GetTicketTasks

This operation return all ticket task lists.

Parameters

Name Key Required Type Description
Ticket
 ticketId True integer

Specify the ID of the ticket.

Returns

The outputs of this operation are dynamic.

Invite users to chat

Operation ID:
InviteUsersToChat

This operation invites users to a chat session.

Parameters

Name Key Required Type Description
Session
 sessionId True string

Specify the chat session ID.
req
 req True dynamic

Returns

response
object

Respond to an Advanced Event

Operation ID:
AdvancedEventResponseHandle

Respond to an Advanced Event.

Parameters

Name Key Required Type Description
Category
 category True string

Select a event category from the list.
Event
 eventType True string

Select an event from the list.
Event ID
 eventId True string

Specify the event ID.
req
 req True dynamic

Returns

response
object

Run an advanced action

Operation ID:
CallAdvancedAction

An advanced action is an Azure Function provides some extra functionalities for the connector.

Parameters

Name Key Required Type Description
Category
 category True string

Select a action category from the list.
Action
 function True string

Select an action from the list.
req
 req True dynamic

Returns

The outputs of this operation are dynamic.

Send a notification to a contact

Operation ID:
CreateContactNotification

This operation sends a notification to a contact in the client portal.

Parameters

Name Key Required Type Description
Contact ID
 contactId True integer

Specify the contact's ID
req
 req True dynamic

Returns

The outputs of this operation are dynamic.

Send a notification to a member

Operation ID:
CreateMemberNotification

This operation sends a notification to a member in the tech portal.

Parameters

Name Key Required Type Description
Member ID
 memberId True integer

Specify the member's ID
req
 req True dynamic

Returns

The outputs of this operation are dynamic.

Send a system message in chat

Operation ID:
AddChatSystemMessage

This operation sends a system message in a chat session.

Parameters

Name Key Required Type Description
Session
 sessionId True string

Specify the chat session ID.
req
 req True dynamic

Returns

response
object

Update a ticket

Operation ID:
UpdateTicket

This operation updates a ticket.

Parameters

Name Key Required Type Description
req
 req True dynamic
Ticket
 ticketId True integer

Specify the ID of the ticket.

Returns

The outputs of this operation are dynamic.

Triggers

When a chat session is created or updated

This operation triggers when a chat is created or updated.
When a ticket is created or updated

This operation triggers when a ticket is created or updated.
When a workflow is triggered

This operation triggers when the specified workflow is triggered. Workflows can be managed in your admin portal.
When an Advanced Event occurred

Use this trigger and the 'Respond to an Advanced Event' to handle an Advanced Event.

When a chat session is created or updated

Operation ID:
CreateChatWebhook

This operation triggers when a chat is created or updated.

Parameters

Name Key Required Type Description
Event
 type True string

Specify the type of event to subscribe to.
req
 req True dynamic

Returns

The outputs of this operation are dynamic.

When a ticket is created or updated

Operation ID:
CreateTicketWorkflow

This operation triggers when a ticket is created or updated.

Parameters

Name Key Required Type Description
Event
 type True string

Specify the type of event to subscribe to.
req
 req True dynamic

Returns

The outputs of this operation are dynamic.

When a workflow is triggered

Operation ID:
SubscribeToWorkflow

This operation triggers when the specified workflow is triggered. Workflows can be managed in your admin portal.

Parameters

Name Key Required Type Description
Type
 type True string

Specify the type of the workflow
Workflow
 workflowId True string

Specify the workflow
req
 req True dynamic

Returns

The outputs of this operation are dynamic.

When an Advanced Event occurred

Operation ID:
AdvancedEventSubscribe

Use this trigger and the 'Respond to an Advanced Event' to handle an Advanced Event.

Parameters

Name Key Required Type Description
Category
 category True string

Select a event category from the list.
Event
 eventType True string

Select an event from the list.
req
 req True dynamic

Returns

The outputs of this operation are dynamic.

Definitions

object

This is the type 'object'.