Connectors / Service / Zendesk Sunshine

Artisan IMG > Zendesk Sunshine (zendesk-sunshine)

Zendesk Sunshine

Zendesk Sunshine is a modern, open and flexible CRM platform built that helps you gain a complete picture of the customer, using any data, from anywhere.


Zendesk Sunshine is an open customer relationship platform designed to work with all your business applications. Built on AWS, it has a modern approach to CRM systems with the idea of creating personalised experiences at the forefront.


When using the Zendesk Sunshine connector, the first thing you will have to do is click on 'New Authentication' in the step editor:


You will immediately get a popup asking you for an authentication name, and Zendesk Sunshine specific details:

Add authentication

As you can see from the above image, in order to complete authentication set up, requires that you input your Zendesk Sunshine 'Subdomain', 'Admin email address', and an 'API key'.

Your subdomain can be found in your Zendesk Sunshine account URL. For example: the subdomain of : would be: docsdemo.

Your admin email address is the email address you use to log into your Zendesk Sunshine account.

In order to find the API key you must go into your Zendesk Sunshine account dashboard.

Navigate to the main admin page of your Zendesk account. Click on the settings icon in the left hand navigation panel, and then scroll down until you get to a heading titled 'CHANNELS'. Under this heading you will see an option called 'API'. Click through.


In order to add or create a new API token you MUST have the 'Token Access' AND 'Password Access' switched to 'Enabled'.

Compare the image above and below for further details.


As you can see, once enabled, you will now be able to generate a new key. Click on the plus button, and copy your key to keep it safe. Note the warning message about not being able to retrieve it once lost, you will have to make a new one instead.


Now that you have all these details collected, add them into your auth popup:


Once you have added the authentication, it will already be selected in the authentication section in the properties panel.

Authentication created and selected

Available Operations

The examples below show one or two of the available connector operations in use.

Please see the Full Operations Reference at the end of this page for details on all available operations for this connector.

Example usage

This brief tutorial will demonstrate how to use the Zendesk Sunshine connector to create a relationship record. Relationship records create associations between object records based on a pre-defined relationship type.

In this scenario we will create an one-to-many relationship record between a "Bug ticket" object record, and a "Customer" object record.

  1. Setup your manual trigger and create the Customer object record.

  2. Create the Bug ticket object record.

  3. Create a relationship record.

Note: Custom object records are created as per the object types defined by you, in your account. All available object types in your account can be retrieved using the List object type operation.

The completed workflow looks like this:

Completed Zendesk Sunshine workflow

1 - Setup trigger and Customer object

The first step is to go to your dashboard, click on the 'Create new workflow' button in the top right corner and name your project workflow. This can be edited later if need be.

Select 'Manual trigger'. There is only one operation available for this trigger and no authorisation needed.

If you have not already completed Zendesk authentication setup, please go through the tutorial outlined above.

In the connectors panel, select the Zendesk Sunshine connector and make sure your authentication is selected.

In order to create the custom object record, you need to input the 'Type' give it two attribute values: 'Name' and 'Value':


Click on the greyed out 'Add Item' button and fill in the relevant fields appropriately.

Note that for the sake of simplicity, we have hard coded in the values here but in a real world scenario you would ost likely use interpolation in order to get your values generated automatically.


2 - Create a bug ticket record

Get another Zendesk Sunshine connector and repeat the process this time making sure you have bug specific detailing (the operation will be the same also):


3 - Create a relationship

In this step it is easier to demonstrate the usage of interpolation as we already have a couple of steps created that we can use in order to pull the necessary data in from.

As you can see we will need various inout fields filled in on order to comeplete this step:


Here we will use the JSON path: $ as it will get the source and target IDs we need in order to create said relationship between the records previously created.

In order to generate this path we used the connector-snake. By dragging the input field across to our selected connector and choosoing id from the dropdown options made available.


All Operations

Latest version:


Create object record

Creates an object record.

Create object type

Creates an object type describing the properties of the object records to be created of that type.

Create relationship record

Creates a relationship record between two object records based on a relationship type. The relationship type defines the object types of the two object records.

Create relationship type

Creates a relationship type. If a duplicate key is detected, the relationship type is not created.

Create user event

Store an event for a given Zendesk user and profile. If the profile does not exist this operation creates a new one.

Delete object record

Deletes the specified object record.

Delete object type

Deletes the object type with the specified key.

Delete relationship record

Deletes the specified relationship record.

Delete relationship type

Deletes the specified relationship type.

Get object record

Returns the specified object record.

Get object type

Returns the object type with the specified key.

Get profile by ID

Return a profile for a given profile ID.

Get profile by identifier query

Return a profile that matches the given identifier query criteria.

Get relationship type

Returns the specified relationship type

List events by profile ID

Return a list of events for a Sunshine profile by its ID.

List events by profile identifier query

Return a list of events for a Sunshine profile by its identifier query.

List object records by type key & external IDs

Returns object records by object type & external IDs.

List object types

Returns the account's object types. Zendesk object types such as 'zen: user' are not included.

List profiles by user

Retrieve the profiles of a specified Zendesk user.

List related object records

Returns all the object records that the specified object record has relationship records with for the specified relationship type.

List relationship records by object record

Returns the relationship records of a specified relationship type for a specified object record.

List relationship records by type

Returns all the relationship records of the specified relationship type.

List relationship types

Returns the account's relationship types.

Query object records

Return a list of object records that match your query parameters.

Update object record

Updates the attributes object of the specified object record. It does not update any other record properties.

Update object type

Updates the schema or end_users_can_read properties of an object type. It does not update the key.