heaptracetechnology / freshdesk

Freshdesk OMG Microservice

This is omg services for 'Freshdesk'. An online cloud-based customer service software providing helpdesk support with all smart automations to get things done faster.

microserive.guide exec -e API_KEY=<KEY> -e DOMAIN=<DOMAIN> microservice/freshdesk createTicket \
  description:'Test ticket' \
  subject:'Mock Ticket' \
  email:'[e-mail]'

{
  "ccEmails": [],
  "fwd_emails": [],
  "reply_cc_emails": [],
  "ticket_cc_emails": [],
  "fr_escalated": false,
  "spam": false,
  "email_config_id": null,
  "group_id": null,
  "priority": 1,
  "requester_id": 48008271709,
  "responder_id": null,
  "source": 2,
  "company_id": null,
  "status": 2,
  "subject": "Mock Ticket",
  "to_emails": null,
  "product_id": null,
  "id": 41,
  "type": null,
  "due_by": "2019-08-15T07:37:13Z",
  "fr_due_by": "2019-08-13T07:37:13Z",
  "is_escalated": false,
  "description": "<div>Test ticket</div>",
  "description_text": "Test ticket",
  "custom_fields": {},
  "created_at": "2019-08-12T07:37:13Z",
  "updated_at": "2019-08-12T07:37:13Z",
  "tags": [],
  "attachments": []
}

Direct usage in Storyscript:

Create Ticket

>>> freshdesk createTicket description:'<DESCRIPTION>' subject:'<SUBJECT>' email:'<EMAIL>' priority:'<PRIORITY>' status:'<STATUS>' ccEmails='<CC_EMAILS>'
{
  "ccEmails": [],
  "fwd_emails": [],
  "reply_cc_emails": [],
  "ticket_cc_emails": [],
  "fr_escalated": false,
  "spam": false,
  "email_config_id": null,
  "group_id": null,
  "priority": 1,
  "requester_id": 48008271709,
  "responder_id": null,
  "source": 2,
  "company_id": null,
  "status": 2,
  "subject": "Mock Ticket",
  "to_emails": null,
  "product_id": null,
  "id": 41,
  "type": null,
  "due_by": "2019-08-15T07:37:13Z",
  "fr_due_by": "2019-08-13T07:37:13Z",
  "is_escalated": false,
  "description": "<div>Test ticket</div>",
  "description_text": "Test ticket",
  "custom_fields": {},
  "created_at": "2019-08-12T07:37:13Z",
  "updated_at": "2019-08-12T07:37:13Z",
  "tags": [],
  "attachments": []
}

Get Ticket

>>> freshdesk getTicket id:<ID>
{
  "ccEmails": [],
  "fwd_emails": [],
  "reply_cc_emails": [],
  "ticket_cc_emails": [],
  "fr_escalated": false,
  "spam": false,
  "email_config_id": null,
  "group_id": null,
  "priority": 1,
  "requester_id": 48008271709,
  "responder_id": null,
  "source": 2,
  "company_id": null,
  "status": 2,
  "subject": "Mock Ticket",
  "association_type": null,
  "to_emails": null,
  "product_id": null,
  "id": 41,
  "type": null,
  "due_by": "2019-08-15T07:37:13Z",
  "fr_due_by": "2019-08-13T07:37:13Z",
  "is_escalated": false,
  "description": "<div>Test ticket</div>",
  "description_text": "Test ticket",
  "custom_fields": {},
  "created_at": "2019-08-12T07:37:13Z",
  "updated_at": "2019-08-12T07:37:13Z",
  "tags": [],
  "attachments": [],
  "source_additional_info": null
}

Delete Ticket

>>> freshdesk deleteTicket id:<ID>
{
  "success": true,
  "message": "Ticket deleted successfully."
}

Get Ticket List

>>> freshdesk listTicket
["LIST_OF_TICKETS"]

Create Contact

>>> freshdesk createContact name:'<NAME>' email:'<EMAIL>' mobile:'<MOBILE>' phone:'<PHONE>' twitterId:'<TWITTER_ID>' uniqueExternalId:'<UNIQUE_EXTERNAL_ID>'
{
  "active": false,
  "address": null,
  "company_id": null,
  "view_all_tickets": null,
  "deleted": false,
  "description": null,
  "email": "[e-mail]",
  "id": 48008659871,
  "job_title": null,
  "language": "en",
  "mobile": null,
  "name": "Mock name",
  "phone": null,
  "time_zone": "Chennai",
  "twitter_id": null,
  "custom_fields": {},
  "tags": [],
  "other_emails": [],
  "facebook_id": null,
  "created_at": "2019-08-12T07:41:09Z",
  "updated_at": "2019-08-12T07:41:09Z",
  "other_companies": [],
  "unique_external_id": null,
  "avatar": null
}

Get Contact

>>> freshdesk getContact id:<ID>
{
  "active": false,
  "address": null,
  "company_id": null,
  "view_all_tickets": null,
  "description": null,
  "email": "[e-mail]",
  "id": 48008659871,
  "job_title": null,
  "language": "en",
  "mobile": null,
  "name": "Mock name",
  "phone": null,
  "time_zone": "Chennai",
  "twitter_id": null,
  "custom_fields": {},
  "tags": [],
  "other_emails": [],
  "facebook_id": null,
  "created_at": "2019-08-12T07:41:09Z",
  "updated_at": "2019-08-12T07:41:09Z",
  "other_companies": [],
  "unique_external_id": null,
  "avatar": null
}

Delete Contact

>>> freshdesk deleteContact id:<ID>
{
  "success": true,
  "message": "Contact deleted successfully."
}

Get Contact List

>>> freshdesk listContact
["LIST_OF_CONTACTS"]

Curious to learn more?

✨🍰✨

Usage with OMG CLI

Get Ticket

$ omg run getTicket -a id=<ID> -e API_KEY=<API_KEY> -e DOMAIN=<DOMAIN>

Create Ticket

$ omg run createTicket -a description=<DESCRIPTION> -a subject=<SUBJECT> -a email=<EMAIL> -a priority=<PRIORITY> -a status=<STATUS> -a ccEmails=<CC_EMAILS> -e API_KEY=<API_KEY> -e DOMAIN=<DOMAIN>

Delete Ticket

$ omg run deleteTicket -a id=<ID> -e API_KEY=<API_KEY> -e DOMAIN=<DOMAIN>

Get Ticket List

$ omg run listTicket -e API_KEY=<API_KEY> -e DOMAIN=<DOMAIN>

Get Contact

$ omg run getContact -a id=<ID> -e API_KEY=<API_KEY> -e DOMAIN=<DOMAIN>

Create Contact

$ omg run createContact -a name=<NAME> -a email=<EMAIL> -a mobile=<MOBILE> -a phone=<PHONE> -a twitterId=<TWITTER_ID> -a uniqueExternalId=<UNIQUE_EXTERNAL_ID> -e API_KEY=<API_KEY> -e DOMAIN=<DOMAIN>

Delete Contact

$ omg run deleteContact -a id=<ID> -e API_KEY=<API_KEY> -e DOMAIN=<DOMAIN>

Get Contact List

$ omg run listContact -e API_KEY=<API_KEY> -e DOMAIN=<DOMAIN>

Note: The OMG CLI requires Docker to be installed.

License

MIT License.