Zendesk Sunshine

Connection

Establish a connection to your Zendesk account.

Select User or Profile

Select a user or profile you want to retrieve events for.

Filter by Event Creation Date (from)

Only include events with an event creation date later or equal to the submitted start time. Please see the list of supported date and time formats.

Filter by Event Creation Date (To)

Only include events with an event creation date before or equal to the submitted end time. Please see the list of supported date and time formats.

Filter by Event Source

Enter a source to include only events of the specified source.

Filter by Event Type

Enter a type to include only events of the specified type for an event source specified above.

Limit

Set the maximum number of events Boost.space Integrator will return during one execution cycle.

Connection

Establish a connection to your Zendesk account.

Source

Enter the application that sent the event – ‘zendesk’ is a protected source name for Zendesk standard events. Any attempts to use this source when creating an event will result in an error.

Type

Enter the event name you want to store.

Description

Enter the event description.

Properties

Specify details of the event as name-value pairs.

Link Event To

Select whether to link an event to a profile or user.

Connection

Establish a connection to your Zendesk account.

User ID

Map the ID or select the user you want to retrieve the profile for.

Limit

Set the maximum number of profiles Boost.space Integrator will return during one execution cycle.

Connection

Establish a connection to your Zendesk account.

Properties

Specify details of the event as name-value pairs.

Profile ID or Identifier

Select whether to specify a profile by ID or by identifier.

Connection

Establish a connection to your Zendesk account.

Profile Source

Enter the application or system associated with the profile.

Profile Type

Enter the profile type.

Identifier Type

Enter the identifier type, e.g., external_id, or phone_number.

Zendesk Sunshine automatically tries to associate a profile to a Zendesk user if the used identifier type is one of the following: email, external_id, phone_number, facebook, twitter.

Identifier Value

Enter the value of the type (above).

User ID

Select or map the user to attach the profile to a Zendesk user explicitly. Otherwise, Zendesk will attempt to automatically associate the profile to a Zendesk user. For more information, see Profile Creation and Profile Association.

Name

Enter the person’s name for the profile. If you do not submit a name, and Zendesk fails to associate the submitted profile to an existing Zendesk user, then the name of the resulting profile and Zendesk user will default to sunshine_user.

Attributes

Add the details about the profile as key-value pairs.

Additional Profile Identifiers

Add profile identifiers as type-value pairs.

Connection

Establish a connection to your Zendesk account.

Profile ID or Identifier

Select whether to specify a profile that you want to update by the Profile ID or by identifier.

Overwrite

Enable this option to overwrite the profile. Otherwise (when the checkbox is left unchecked), the partial update will be performed – the module changes some, but not all, properties of a profile.

Name

Enter the person’s name for the profile. If you do not submit a name, and Zendesk fails to associate the submitted profile to an existing Zendesk user, then the name of the resulting profile and Zendesk user will default to sunshine_user.

Attributes

Add the details about the profile as key-value pairs.

Additional Profile Identifiers

Add profile identifiers as type-value pairs.

Connection

Establish a connection to your Zendesk account.

User ID

Enter or map the ID of the Zendesk user you want to specify the Sunshine profile for (below).

Profile ID

Enter or map the ID of the Sunshine profile.

Connection

Establish a connection to your Zendesk account.

Object Type Key

Select or map the object type key you want to retrieve object records for.

Order

Sorts by Created At field. Select whether the module output should be sorted in ascending or descending order.

Limit

Set the maximum number of object records Boost.space Integrator will return during one execution cycle.

Connection

Establish a connection to your Zendesk account.

Object Type Key

Select or map the object type key that contains the object record you want to retrieve details for.

Object Record ID

Select or map the ID of the object record you want to retrieve details for.

Connection

Establish a connection to your Zendesk account.

Object Type Key

Select or map the object type key you want to create a record for.

Attributes

Enter value(s) for the record’s attributes.

Optional Additional Attributes

Add additional attributes as key-value pairs.

Some object types will not allow adding attributes that were not predefined.

External ID

Enter a unique, case-insensitive identifier for the object record, usually from another system.

Connection

Establish a connection to your Zendesk account.

Object Type Key

Select or map the object type key that contains an object record you want to update.

Object Record ID

Select or map the record where you want to update attributes at.

Attributes

Enter value(s) for the record’s attributes you want to update.

Optional Additional Attributes

Add additional attributes as key-value pairs.

Some object types will not allow adding attributes that were not predefined.

Connection

Establish a connection to your Zendesk account.

Object Type Key

Select or map the object type key that contains an object record you want to update.

Object Record External ID

Select or map the record’s external ID to specify the object record by.

Attributes

Enter value(s) for the record’s attributes you want to update.

Optional Additional Attributes

Add additional attributes as key-value pairs.

Some object types will not allow adding attributes that were not predefined.

Connection

Establish a connection to your Zendesk account.

Object Type Key

Select or map the object type key that contains the object record you want to delete.

Object Record ID

Enter (map) the ID of the object record you want to delete.

Connection

Establish a connection to your Zendesk account.

Object Type Key

Select or map the object type key that contains the object record you want to delete.

Object Record External ID

Enter (map) the record’s external ID to specify the object record you want to delete by.

Connection

Establish a connection to your Zendesk account.

Object Type Key

Select or map the object type key you want to retrieve related objects for.

Object Record ID

Enter (map) the record’s ID to specify the object record you want to retrieve related objects for.

Relation Type Key

Select the relationship type by the relation type key.

Limit

Set the maximum number of related object records Boost.space Integrator will return during one execution cycle.

Connection

Establish a connection to your Zendesk account.

Object Type Key

Select or map the object type key you want to retrieve related objects for.

Relation Type Key

Select the relationship type by the relation type key.

Limit

Set the maximum number of related relationship records Boost.space Integrator will return during one execution cycle.

Connection

Establish a connection to your Zendesk account.

Relation Type Key

Select or map the relationship type you want to retrieve relationship records for.

Limit

Set the maximum number of relationship records Boost.space Integrator will return during one execution cycle.

Connection

Establish a connection to your Zendesk account.

Object Type Key

Select or map the object type key that contains the relationship record you want to retrieve details for.

Relationship Record ID

Enter (map) the ID of the relationship record you want to retrieve details for.

Connection

Establish a connection to your Zendesk account.

Relationship Type Key

Select or map the relationship type to create a new relationship record by.

Object Records

Select or map object records you want to create a relationship record between.

Connection

Establish a connection to your Zendesk account.

Object Type Key

Select or map the object type key that contains the object record you want to delete.

Relationship Record ID

Enter (map) the relationship record’s ID to specify the record you want to delete.

Connection

Establish a connection to your Zendesk account.

Limit

Set the maximum number of object types Boost.space Integrator will return during one execution cycle.

Connection

Establish a connection to your Zendesk account.

Object Type Key

Enter (map) or select the object type you want to retrieve details about.

Connection

Establish a connection to your Zendesk account.

Object Type Key

Specify a unique identifier for the object type. The key must be between 2 and 32 characters long. Examples: “product“, “cell_phone“, and “2019-car“.

Allow Additional Properties

Disabling this option will limit object records of this object type to only having the properties predefined below.Enable this option to allow additional properties (not defined below) to be added during the creation of an object record.

Properties

Connection

Establish a connection to your Zendesk account.

Object Type Key

Select or map the object type key you want to update.

Connection

Establish a connection to your Zendesk account.

Object Type Key

Enter (map) or select the object type key you want to delete.

Connection

Establish a connection to your Zendesk account.

Limit

Set the maximum number of relationship types Boost.space Integrator will return during one execution cycle.

Connection

Establish a connection to your Zendesk account.

Relation Type Key

Select or map the relation type key you want to retrieve details for.

Connection

Establish a connection to your Zendesk account.

Key

Enter a user-defined unique identifier. Must be between 2 and 32 characters long.

Source

Enter the key of an object type to define the relationship between two object records.

The source must be one of the following:

Target

Enter the key of a different object type to define the relationship between two object records.

Connection

Establish a connection to your Zendesk account.

Relationship Type Key

Select or map the relationship type you want to delete.

Connection

Establish a connection to your Zendesk account.

URL

Enter a path relative to https://{yourdomain}.zendesk.com.For example: /api/sunshine/objects/types/.

For the list of available endpoints, refer to the Zendesk Sunshine API Documentation.

Method

Select the HTTP method you want to use:

GETto retrieve information for an entry.

POSTto create a new entry.

PUTto update/replace an existing entry.

PATCHto make a partial entry update.

DELETEto delete an entry.

Headers

Enter the desired request headers. You don’t need to add authorization headers; we’ve already done this for you.

Query String

Enter the request query string.

Body

Enter the body content for your API call.

additionalProperties cannot be set to true

Example of the returned message:

{"object_type_key": "The_key1","message": ["data.schema instance value ([\"boolean\"]) not found in enum (possible values: [\"boolean\",\"integer\",\"number\",\"string\",\"array\"])","additionalProperties cannot be set to true"]}

The schema contains the additionalProperties property, and the value for that property is set to true.

To fix this:1. Select the desired object type in the Object Type Key field of the Update Object Type Alternative module.2. Verify that every field is set up as you want, and the required properties are still checked as required.3. Run the module to set additionalProperties as false.

data.schema instance value ([“boolean”]) not found in enum (possible values: [“boolean”,”integer”,”number”,”string”,”array”])

data.schema instance value ([“string”]) not found in enum (possible values: [“boolean”,”integer”,”number”,”string”,”array”])

data.schema instance value ([“string”,”object”]) not found in enum (possible values: [“boolean”,”integer”,”number”,”string”,”array”])…..data.schema instance value ([xxxxxxxxxxxxx]) not found in enum (possible values: [“boolean”,”integer”,”number”,”string”,”array”])

…

Previously you were able to send “type”: “string” or “type”: [“string”] to Zendesk to make the type of the property “string”. Now you can only send “string”.To fix this:1. Select the desired object type in the Object Type Key field of the Update Object Type Alternative module.2. Check that every field is set up as you want, and the required properties are still checked as required.3. Run the Update Object Type Alternative module.

The schema for an object type cannot be empty.

The properties element of a schema cannot be empty.

The schema is empty or the schema’s properties property is empty.

You have to add a property to this object type using the Update Object Type Alternative module. Use the New Properties field.

data.schema object has missing required properties ([“type”])

The schema defines a property but does not specify a type for the property. One of the properties of your object type does not have a selected type. Use the Update Object Type Alternative module to find the property without a type, and assign it a type. Check that every field is set up as you want, and the required properties are still checked as required before running the module.

data.schema object instance has properties which are not allowed by the schema: [“pattern”]

data.schema object instance has properties which are not allowed by the schema: [“maximum”,”minimum”]

data.schema object instance has properties which are not allowed by the schema: [“maxLength”,”minLength”]

data.schema object instance has properties which are not allowed by the schema: [“enum”]

The schema contains properties that are not allowed (“pattern” (regex), “minLength”, “maxLength”, “enum”,”minimum” or “maximum”).

1. Select the desired object type in the Object Type Key field of the Update Object Type Alternative module.2. Check that every field is set up as you want, and the required properties are still checked as required.3. Run the Update Object Type Alternative module.

Unwanted properties have been removed from the schema.

Connection

Establish a connection to your Zendesk Sunshine account.

Object Type Key

Select the object type whose properties you want to update.

Properties

Specify the new properties of the object type.

The previous property type is displayed in the description under the field.

New Properties

Add the new properties to the object type.

Required

Select properties that you want to set as required.