InTouch Hub · Blue Isle Software

Deskpro

Create and manage tickets, people, and organizations in Deskpro helpdesk via the Deskpro REST API v2.

deskprosupportticketshelpdesk

Deskpro

Create and manage tickets, people, and organizations in Deskpro helpdesk via the Deskpro REST API v2.

Operations

Operation Description
list_tickets List recent tickets in your helpdesk
get_ticket Get a single ticket by ID
create_ticket Create a new support ticket
list_people List people (contacts); optionally filter by email
get_person Get a single person by ID
create_person Create a new person (contact)

API Key Setup

  1. Log in to your Deskpro instance as an admin.
  2. Go to Admin > Apps > API Keys.
  3. Click Add API Key, give it a name, choose the agent account it runs as, and save.
  4. Copy the Key Code — it looks like 2:YWK2PGCS8CNW62SR8TBTBKWMY.
  5. Paste it as the apiKey input to this tool.

The tool sends Authorization: key <apiKey> on every request, which is the standard Deskpro v2 auth scheme.

Inputs

Input Required Description
apiKey Yes Deskpro API key code from Admin > Apps > API Keys
helpdeskUrl Yes Your helpdesk base URL, e.g. https://mycompany.deskpro.com
operation Yes One of the operations listed above
ticketId Conditional Required for get_ticket
subject Conditional Required for create_ticket
message Conditional Required for create_ticket (body of the first message)
personEmail Conditional Required for create_ticket and create_person; optional filter for list_people
personId Conditional Required for get_person
personName Conditional Required for create_person

Examples

List open tickets:

operation: list_tickets
apiKey: 2:YWK2PGCS8CNW62SR8TBTBKWMY
helpdeskUrl: https://mycompany.deskpro.com

Get a specific ticket:

operation: get_ticket
apiKey: 2:YWK2PGCS8CNW62SR8TBTBKWMY
helpdeskUrl: https://mycompany.deskpro.com
ticketId: 42

Create a ticket:

operation: create_ticket
apiKey: 2:YWK2PGCS8CNW62SR8TBTBKWMY
helpdeskUrl: https://mycompany.deskpro.com
subject: Printer not working
message: The office printer on floor 2 shows error code E5.
personEmail: [email protected]

Find a contact by email:

operation: list_people
apiKey: 2:YWK2PGCS8CNW62SR8TBTBKWMY
helpdeskUrl: https://mycompany.deskpro.com
personEmail: [email protected]

Create a new contact:

operation: create_person
apiKey: 2:YWK2PGCS8CNW62SR8TBTBKWMY
helpdeskUrl: https://mycompany.deskpro.com
personName: Alice Smith
personEmail: [email protected]

Outputs

Output Description
result Raw JSON response body from the Deskpro API
status HTTP status code as a string (e.g. 200, 201)