HaloPSA

the halopsa connector enables automated interactions with the halopsa ticketing system, facilitating efficient ticket management and incident resolution halopsa is a comprehensive professional services automation (psa) solution that streamlines ticket management and incident tracking for it service management this connector enables swimlane turbine users to automate ticket operations, such as adding, updating, retrieving, and deleting tickets within halopsa by integrating with halopsa, security teams can efficiently manage service requests, incidents, and changes directly from the swimlane platform, enhancing response times and operational efficiency limitations none to date supported versions this connector supports the latest version of the halopsa rest api additional docs halopsa authentication link https //swimlane halopsa com/apidoc/authentication/clienthalopsa api docs https //swimlane halopsa com/apidoc/resources/tickets configuration prerequisites to effectively utilize the halopsa connector within the swimlane turbine platform, ensure you have the following prerequisites oauth2 password credentials with the following parameters url the endpoint url for the halopsa api halopsa username your halopsa account username halopsa password your halopsa account password client id the client identifier as registered in halopsa scopes the scope of access requested from halopsa oauth2 client credentials with the following parameters url the endpoint url for the halopsa api client id the client identifier as registered in halopsa client secret the secret key associated with your client id in halopsa scopes the scope of access requested from halopsa authentication methods to effectively utilize the halopsa connector within swimlane turbine, ensure you have the following prerequisites oauth 2 0 client credentials for authentication with these parameters url endpoint for halopsa api access client id unique identifier for the application making the request client secret a secret known only to the application and the authorization server scopes permissions the application needs to function correctly oauth 2 0 password credentials for authentication with these parameters url endpoint for halopsa api access halopsa username your halopsa user account name halopsa password your halopsa user account password client id unique identifier for the application making the request scopes permissions the application needs to function correctly capabilities this connector provides the following capabilities add or update ticket delete ticket by id get ticket by id get tickets add or update ticket adds or updates one or more tickets if id is included then updates, if not included then creates new halopsa's documentation for this action can be found here https //swimlane halopsa com/apidoc/resources/tickets delete ticket by id deletes the ticket and related objects with the specified id halopsa's documentation for this action can be found here https //swimlane halopsa com/apidoc/resources/tickets get ticket by id returns a single ticket object halopsa's documentation for this action can be found here https //swimlane halopsa com/apidoc/resources/tickets get tickets returns an object containing the count of tickets, and an array of ticket objects halopsa's documentation for this action can be found here https //swimlane halopsa com/apidoc/resources/tickets configurations halopsa oauth 2 0 client credentials authenticates using oauth 2 0 client credentials configuration parameters parameter description type required url a url to the target host string required tenant id the tenant id string optional client id the client id string required client secret the client secret string required scope permission scopes for this action array required verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional halopsa oauth 2 0 password grant authenticates using oauth 2 0 client credentials configuration parameters parameter description type required url a url to the target host string required tenant id the tenant id string optional oauth2 username the username for authentication string required oauth2 password the password for authentication string required client id the client id string required scope permission scopes for this action array required verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional actions add or update ticket add or update a ticket in halopsa, determining the action by the presence of a ticket id endpoint url /api/tickets method post output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 201,"response headers" {"content type" "text/html; charset=utf 8","x hsci cache time" "2024 10 21t12 01 22 328z","content encoding" "gzip","expires" "mon, 21 oct 2024 12 08 57 gmt","cache control" "max age=0, no cache, no store","pragma" "no cache","date" "mon, 21 oct 2024 12 08 57 gmt"},"reason" "ok","json body" {}} delete ticket by id removes a ticket and its related objects from halopsa using the provided unique id endpoint url /api/tickets/{{id}} method delete input argument name type required description parameters reason string optional the reason for ticket's deletion path parameters id string required the ticket's id input example {"parameters" {"reason" "duplicate ticket "},"path parameters" {"id" "463"}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"response headers" {"content type" "text/html; charset=utf 8","x hsci cache time" "2024 10 21t12 01 22 328z","content encoding" "gzip","expires" "mon, 21 oct 2024 12 08 57 gmt","cache control" "max age=0, no cache, no store","pragma" "no cache","date" "mon, 21 oct 2024 12 08 57 gmt"},"reason" "ok","json body" {}} get ticket by id retrieve a specific ticket from halopsa using the unique identifier (id) provided endpoint url /api/tickets/{{id}} method get input argument name type required description parameters includedetails boolean optional whether to include extra objects in the response parameters includelastaction boolean optional whether to include the last action in the response parameters ticketidonly boolean optional returns only the id fields (ticket id, sla id, status id, client id and name and lastincomingemail date) of the tickets (not compatible with pagination) path parameters id number required the ticket's id input example {"parameters" {"includedetails"\ false,"includelastaction"\ false,"ticketidonly"\ false},"path parameters" {"id" 3}} output parameter type description status code number http status code of the response reason string response reason phrase actioncode number output field actioncode id number unique identifier dateoccurred string output field dateoccurred status id number unique identifier tickettype id number unique identifier sla id number unique identifier priority id number unique identifier client id number unique identifier timetaken number output field timetaken respondbydate string date value responsedate string date value responsestartdate string date value slaresponsestate string output field slaresponsestate fixbydate string date value dateclosed string output field dateclosed excludefromsla boolean output field excludefromsla slaholdtime number time value slaactiondate string date value slapercused number output field slapercused slatimeleft number output field slatimeleft lastactiondate string date value organisation id number unique identifier department id number unique identifier output example {"status code" 200,"response headers" {"content type" "text/html; charset=utf 8","x hsci cache time" "2024 10 21t12 01 22 328z","content encoding" "gzip","expires" "mon, 21 oct 2024 12 08 57 gmt","cache control" "max age=0, no cache, no store","pragma" "no cache","date" "mon, 21 oct 2024 12 08 57 gmt","content length" "106931","connection" "keep alive"},"reason" "ok","json body" {"actioncode" 0,"id" 0,"dateoccurred" "2019 08 02t14 35 55 618z","status id" 0,"tickettype id" 0,"sla id" 0,"priority get tickets retrieve an array of ticket objects from halopsa, offering a summary of existing tickets endpoint url /api/tickets method get input argument name type required description parameters pageinate boolean optional whether to use pagination in the response parameters page size number optional when using pagination, the size of the page maximum size is 100 parameters page no number optional when using pagination, the page number to return parameters order string optional the name of the field to order by parameters orderdesc boolean optional whether to order ascending or descending parameters ticketidonly boolean optional returns only the id fields (ticket id, sla id, status id, client id and name and lastincomingemail date) of the tickets (not compatible with pagination) parameters view id number optional the id of the filter profile to filter by parameters columns id number optional the column profile id parameters includecolumns boolean optional include column details in the response parameters includeslaactiondate boolean optional include the sla action date in the response parameters includeslatimer boolean optional include sla timer in the response parameters includetimetaken boolean optional include time taken in the response parameters includesupplier boolean optional include supplier details in the response parameters includerelease1 boolean optional include release 1 details in the response parameters includerelease2 boolean optional include release 2 details in the response parameters includerelease3 boolean optional include release 3 details in the response parameters includechildids boolean optional include child ticket ids in the response parameters includenextactivitydate boolean optional include nextactivitydate in the response parameters includefirstresponse boolean optional include first response data in the response parameters list id number optional filters by the specified list parameters agent id number optional filters by the specified agent parameters status id number optional filters by the specified status parameters requesttype id number optional filters by the specified request type parameters supplier id number optional filters by the specified supplier parameters client id number optional filters by the specified client input example {"parameters" {"pageinate"\ false,"page size" 10,"page no" 10,"order" "","orderdesc"\ false,"ticketidonly"\ false,"view id" 10,"columns id" 10,"includecolumns"\ false,"includeslaactiondate"\ false,"includeslatimer"\ false,"includetimetaken"\ false,"includesupplier"\ false,"includerelease1"\ false,"includerelease2"\ false,"includerelease3"\ false,"includechildids"\ false,"includenextactivitydate"\ false,"includefirstresponse"\ false,"list id" 10,"agent id" 10,"status id" 10,"requesttype id" 10,"supplier id" 10,"client id" 10,"site" 10,"username" "david","user id" 10,"release id" 10,"asset id" 10,"itil requesttype id" 10,"open only"\ false,"closed only"\ false,"unlinked only"\ false,"contract id" 10,"withattachments"\ false,"team" \[10],"agent" \[10],"status" \[10],"requesttype" \[10],"itil requesttype" \[10],"category 1" \[10],"category 2" \[10],"category 3" \[10],"category 4" \[10],"sla" \[10],"priority" \[10],"products" \[10],"flagged" \[10],"excludethese" \[10],"search" "","searchactions"\ false,"datesearch" "","startdate" "","enddate" "","search user name" "","search summary" "","search details" "","search reportedby" "","search version" "","search release1" "","search release2" "","search release3" "","search releasenote" "","search inventory number" "","search oppcontactname" "","search oppcompanyname" ""}} output parameter type description status code number http status code of the response reason string response reason phrase page no number output field page no page size number output field page size record count number count value tickets array output field tickets tickets id number unique identifier tickets dateoccurred string output field tickets dateoccurred tickets summary string output field tickets summary tickets status id number unique identifier tickets tickettype id number unique identifier tickets sla id number unique identifier tickets priority id number unique identifier tickets client id number unique identifier tickets client name string name of the resource tickets site id number unique identifier tickets site name string name of the resource tickets user name string name of the resource tickets team string output field tickets team tickets agent id number unique identifier tickets agent name string name of the resource tickets category 1 string output field tickets category 1 tickets category 2 string output field tickets category 2 tickets category 3 string output field tickets category 3 tickets category 4 string output field tickets category 4 output example {"status code" 200,"response headers" {"content type" "text/html; charset=utf 8","x hsci cache time" "2024 10 21t12 01 22 328z","content encoding" "gzip","expires" "mon, 21 oct 2024 12 08 57 gmt","cache control" "max age=0, no cache, no store","pragma" "no cache","date" "mon, 21 oct 2024 12 08 57 gmt","content length" "106931","connection" "keep alive"},"reason" "ok","json body" {"page no" 0,"page size" 0,"record count" 0,"tickets" \[{}],"columns id" 0,"columns" \[{}]}} response headers header description example cache control directives for caching mechanisms max age=0, no cache, no store connection http response header connection keep alive content encoding http response header content encoding gzip content length the length of the response body in bytes 106931 content type the media type of the resource text/html; charset=utf 8 date the date and time at which the message was originated mon, 21 oct 2024 12 08 57 gmt expires the date/time after which the response is considered stale mon, 21 oct 2024 12 08 57 gmt pragma http response header pragma no cache x hsci cache time http response header x hsci cache time 2024 10 21t12 01 22 328z