README.md

In TifMoe/RZendesk: Zendesk SDK for R

RZendesk

Wrapper function for accessing Sittercity Zendesk API in R

Setup

1) Install and Load Library Locally

Add library to your local project

# requires install.packages('devtools')
devtools::install_github("TifMoe/RZendesk")
library(RZendesk)

This package was initially created as a useful tool for myself and will evolve over time as more functionality is added. Please don't hesitate to reach out to me if there's a particular function you're looking for.

2) Setup Environmental Variables

ZENDESK_USER= 'valid Zendesk username'/token
ZENDESK_TOKEN= 'Zendesk API token'
ZENDESK_URL= https://your_organization.zendesk.com/api/v2

Configuring project-only environmental variables for RStudio

To setup local environmental variables just for a given R package, you can create an .Renviron file for storing the above variables. To create a new .Renviron file, open a new text file in RStudio and save as '.Renviron'

Usage

Get a Ticket from Zendesk API

# call get_ticket and pass Zendesk ticket number as string
get_ticket(ticket = '12345678')

The get_ticket function will return an object with three attributes:

# save ticket in variable
ticket <- get_ticket(ticket = '12345678')

# view content of ticket (json response parsed as named list)
ticket$content

# view headers passed for API call
ticket$headers

# view response from API call for ticket
ticket$response

Post a new ticket through Zendesk API

# call post_ticket and pass parameters to create new ticket
post_ticket(
      requester_name = 'fake_name',
      requester_email = 'fake_email',
      body = 'comment in body of ticket',
      subject = 'subject of ticket',
      group = 1234567,
      tags = list('tag1','tag2','tag3'),
      public = FALSE
)

The group, tags and public parameters are all optional and can be set to NULL or left out entirely. The public parameter will be set to 'FALSE' by default, creating a private comment in the new ticket.

TifMoe/RZendesk documentation built on May 9, 2019, 4:46 p.m.