| Contact us |
|---|
| We are preparing the connectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…). More with this application for you. In the meantime, please create your own connection. |
![[Important]](https://docs.boost.space/wp-content/themes/bsdocs/docs-parser/HTML/css/image/important.png)
With Zendesk modulesThe module is an application or tool within the Boost.space system. The entire system is built on this concept of modularity. (module - Contacts) More in Boost.spaceCentralization and synchronization platform, where you can organize and manage your data. More IntegratorPart of the Boost.space system, where you can create your connections and automate your processes. More you can watch, create, update, list, retrieve, and delete the articles, comments, forum posts, groups, organizations, tickets, and usersCan use the system on a limited basis based on the rights assigned by the admin. More in your Zendesk account.
To use the Zendesk modules, you must have a Zendesk account. You can create an account at zendesk.com/register.
Refer to the Zendesk API documentation for a list of available endpoints.
To establish the connection, you must:
-
Create a custom application in Zendesk to obtain your Unique Identifier and Secret.
To create a Zendesk custom application and retrieve your client credentials:
-
Log in to your Zendesk account.
-
In the left navigation menu, click Apps and integrations > APIs > Zendesk API.
-
Go to OAuth Clients and click Add OAuth Clients.
-
For Client name, enter a name.
-
For Unique identifier, you can use the default suggestion or you can change it. Copy the Unique Identifier value and store it in a safe place.
-
For Redirect URLs, enter the following:
https://integrator.boost.space/oauth/cb/zendesk/ -
Click Save.
-
A dialog box will open, advising you that the Secret value will only be shown once. Click OK.
-
Copy the Secret value and store it in a safe place.
-
Click Save.
You will use these values in the Unique Identifier and Secret fields in Boost.space Integrator.
To establish the connection in Boost.space Integrator:
-
Log in to your Boost.space Integrator account, add a Zendesk moduleThe module is an application or tool within the Boost.space system. The entire system is built on this concept of modularity. (module - Contacts) More to your scenarioA specific connection between applications in which data can be transferred. Two types of scenarios: active/inactive. More, and click Create a connection.
-
Optional: In the Connection name field, enter a name for the connection.
-
In theDomain field, enter your Zendesk domain. You can find your Zendesk domain in your browser’s address bar. Example: domain.zendesk.com.
-
In theUnique Identifier field, enter the Unique Identifier value copied above.
-
In the Secret field, enter the Secret value copied above.
-
Click Save.
-
If prompted, authenticate your account and confirm access.
You have successfully established the connection. You can now edit your scenario and add more Zendesk modules. If your connection requires reauthorization at any point, follow the connection renewal steps here.
This app uses webhooks to triggerEvery scenario has a trigger, an event that starts your scenario. A scenario must have a trigger. There can only be one trigger for each scenario. When you create a new scenario, the first module you choose is your trigger for that scenario. Create a trigger by clicking on the empty module of a newly created scenario or moving the... a scenario when an event occurs instantly. All webhookA webhook is a way for an app to send real-time information to a specific URL in response to certain events or triggers. modules have an instant tag next to their name.
To set up a webhook, follow these steps:
-
Add a Zendesk
instantmodule to your scenario and click Create a webhook. -
Optional: Enter a name for the webhook in the Webhook name field.
-
Select the corresponding connection for the webhook in the Connection field.
-
Click Save > Copy address to clipboard. You will use this link to set up your webhook in your Zendesk account.
-
Log in to your Zendesk account.
-
Click Apps and integrations > WebhooksA webhook is a way for an app to send real-time information to a specific URL in response to certain events or triggers..
-
Click Create webhook.
-
Choose Trigger or automation and click Next.
-
Enter a name for your webhook.
-
Enter the Endpoint URL that was copied from Boost.space Integrator.
-
Choose your Request method, Request format, and Authentication type and click Create webhook.
-
Next, you will need to select a trigger or automation in the AdminAdmins in Boost.space have exclusive access to system settings. They manage the overall system setup, including appearance, language, currency, user settings, and the availability of individual modules to users and teams. More Center. Click Add trigger and enter a name.
-
Choose a Category.
-
Set the conditions that are necessary for the trigger to run.
-
Under Actions, select Notify by > active webhook and then choose your new webhook that you just created. Click Create.
-
Return to the Webhooks page and click Finish setup.
Zendesk will now send data to Boost.space Integrator through the webhook when the selected event occurs.
TriggersEvery scenario has a trigger, an event that starts your scenario. A scenario must have a trigger. There can only be one trigger for each scenario. When you create a new scenario, the first module you choose is your trigger for that scenario. Create a trigger by clicking on the empty module of a newly created scenario or moving the... when a new ticket is created.
Required Permissions: read
|
Connection |
|
|
Watch |
Select the option for the tickets you want to watch:
|
|
Search By |
Select or map the option to search the tickets: |
|
Filtering |
Enter (map) the query to search for the tickets that match the specified query. For more information on setting up a filter, see the Zendesk documentation. The |
|
Filter |
Select or map the field and its value to search for the tickets that match the specified filters. |
|
Limit |
Set the maximum number of tickets Boost.space Integrator should return during one scenario execution cycleA cycle is the operation and commit/rollback phases of scenario execution. A scenario may have one or more cycles (one is the default).. |
Checks whether new tickets were created in a view.
Required Permissions: read
|
Connection |
|
|
View ID |
Select or map the View ID in which you want to watch the tickets. |
|
Watch |
Select or map the option to search the tickets:
|
|
StatusCreate statuses for each module separately to create an ideal environment for efficient and consistent work. More |
Select or map the status of the ticket you want to watch:
|
|
Limit |
Set the maximum number of tickets Boost.space Integrator should return during one scenario execution cycle. |
Checks whether there are new audits (activity) on a ticket.
Required Permissions: read
|
Connection |
|
|
Ticket ID |
Enter the Ticket ID whose activities you want to watch. |
|
Limit |
Set the maximum number of tickets Boost.space Integrator should return during one scenario execution cycle. |
Retrieves all tickets (except for archived or soft-deleted tickets).
Required Permissions: read
|
Connection |
|
|
Sort By |
Select or map the option to sort the tickets you are searching for:
|
|
Sort Order |
Select or map the order to list the tickets:
|
|
Filter by User or Organization |
Select or map the option to filter the tickets:
|
|
User |
Select or map the user whose tickets you want to list. |
|
Filter |
Select or map the option to list the specific tickets of the user:
|
|
Filter by Organization |
Select or map the organization whose tickets you want to list. |
|
Limit |
Set the maximum number of tickets Boost.space Integrator should return during one scenario execution cycle. |
Returns tickets that match specified criteria.
Required Permissions: read
|
Connection |
|
|
Search By |
Select or map the option to search the tickets:
|
|
Filtering |
Enter (map) the query to search the tickets that match the specified query. For more information on setting up a filter, see the Zendesk documentation. The |
|
Filter |
Select or map the field and its value to search the tickets that match the specified filters. |
|
Sort by |
Select or map the option to sort the tickets you are searching for:
|
|
Sort order |
Select or map the order to list the tickets:
|
|
Limit |
Set the maximum number of tickets Boost.space Integrator should return during one scenario execution cycle. |
Retrieves tickets that were soft deleted.
Required Permissions: read
|
Connection |
|
|
Sort By |
Select or map the option to sort the deleted tickets:
|
|
Sort Order |
Select or map the order to the deleted tickets:
|
|
Limit |
Set the maximum number of tickets Boost.space Integrator should return during one scenario execution cycle. |
Retrieves a ticket.
Required Permissions: read
|
Connection |
|
|
Ticket ID or Ticket External ID |
Select or map the option to choose the ticket whose details you want to retrieve:
|
|
Ticket ID |
Select or map the Ticket ID whose details you want to retrieve. |
|
Ticket External ID |
Select or map the Ticket External ID whose details you want to retrieve. |
Creates a ticket.
Required Permissions: read, write
|
Connection |
|
|
Subject |
Enter the subject line of the ticket. |
|
Comment Type |
Select the comment type of the ticket:
|
|
Comment |
Enter (map) the comment text either in HTML Body or plain text format. |
|
Public Comment |
Select the checkbox if this is a public comment. By default, the comment is an internal note; if you check this box, it becomes a public comment. The email CC field only works if public comment is sent. |
|
Author ID |
Select or map the Author ID who is entering the comment. |
|
Uploads |
Add the upload tokenThe API token is a multi-digit code that allows a user to authenticate with cloud applications. More to upload the attachments. |
|
Closed Ticket ID |
Select or map the Closed Ticket ID of a closed ticket for which you create a follow-up ticket. |
|
Type |
Select or map the ticket type:
|
|
Priority |
Select the priority of the ticket:
|
|
Status |
Select the status of the ticket:
|
|
Requester ID |
Enter the Requester ID who raised the support ticket. |
|
Submitter ID |
Enter the submitter ID who submitted the ticket. The submitter becomes the author of the first comment on the ticket if no author ID is provided. |
|
Assignee ID |
Enter the Assignee ID to whom the ticket is assigned. |
|
Group ID |
Enter the Group ID to which the ticket is assigned. |
|
Recipient |
Enter (map) the original recipient e-mail address of the ticket. |
|
Collaborators |
Select the collaborators of the ticket. This field allows the selection of multiple user IDs for collaborators. However, this field can be used more flexibly (adding users through email or even on-the-fly creation of users). For more information, see the Zendesk Documentation. |
|
Followers |
Add the User ID and email address of the users whom you want to add as followers for the ticket. |
|
Email CCs |
Add the User ID and email address of the users you want to add to the CC field of the email you want to send regarding the ticket. |
|
Ticket Form ID |
Select or map the Ticket Form ID option from the list. |
|
Macro IDs |
Select or map the Macro ID for the ticket. For example, |
|
Tags |
Enter the tags to filter the ticket when searching. |
|
Brand ID |
Select or map the Brand ID of the ticket. For example, |
|
Metadata |
Enter (map) the ticket metadata in JSON format. For more information, see the Zendesk Documentation. |
|
External ID |
Enter an External ID to associate the Zendesk ticket with the local recordsOne row in the Boost.space database. These are individual rows under spaces in each module. For example single products, but not their variants. More. |
|
Problem ID |
Enter the Problem ID linked to the incident if the ticket type is selected as an incident. |
|
Custom FieldsA feature in Boost.space that allows you to define and manage data within each module according to your specific needs. More |
Add the custom fields and their values. For example, |
Updates a ticket. The update allows for adding a new comment too.
Required Permissions: read, write
|
Connection |
|
|
Ticket ID |
Select or map the Ticket ID whose details you want to update. |
|
Comment Type |
Select the comment type of the ticket:
|
|
Comment |
Enter (map) the comment text either in HTML Body or plain text format. |
|
Public Comment |
Select the checkbox if this is a public comment. By default, the comment is an internal note; if you check this box, it becomes a public comment. The email CC field only works if public comment is sent. |
|
Author ID |
Select or map the Author ID who is entering the comment. |
|
Uploads |
Add the upload token to upload the attachments. |
|
Closed Ticket ID |
Select or map the Closed Ticket ID of a closed ticket for which you create a follow-up ticket. |
|
Type |
Select or map the ticket type:
|
|
Priority |
Select the priority of the ticket:
|
|
Status |
Select the status of the ticket:
|
|
Requester ID |
Enter the Requester ID who raised the support ticket. |
|
Submitter ID |
Enter the submitter ID who submitted the ticket. The submitter becomes the author of the first comment on the ticket if no author ID is provided. |
|
Assignee ID |
Enter the Assignee ID to whom the ticket is assigned. |
|
Group ID |
Enter the Group ID to which the ticket is assigned. |
|
Recipient |
Enter (map) the original recipient e-mail address of the ticket. |
|
Collaborators |
Select the collaborators of the ticket. This field allows the selection of multiple user IDs for collaborators. However, this field can be used more flexibly (adding users through email or even on-the-fly creation of users). For more information, see the Zendesk Documentation. |
|
Followers |
Add the User ID and email address of the users you want to add as followers for the ticket. |
|
Email CCs |
Add the User ID and email address of the users you want to add to the CC field of the email you want to send regarding the ticket. |
|
Ticket Form ID |
Select or map the Ticket Form ID option from the list. |
|
Macro IDs |
Select or map the Macro ID for the ticket. For example, |
|
Tags |
Enter the tags to filter the ticket when searching. |
|
Brand ID |
Select or map the Brand ID of the ticket. For example, |
|
Metadata |
Enter (map) the ticket metadata in JSON format. For more information, see the Zendesk Documentation. |
|
External ID |
Enter an External ID to associate the Zendesk ticket with the local records. |
|
Problem ID |
Enter the Problem ID linked to the incident if the ticket type is selected as an incident. |
|
Custom Fields |
Add the custom fields and their values. For example, |
Merges tickets into a single ticket.
Required Permissions: read, write
|
Connection |
|
|
Ticket ID |
Enter the target Ticket ID to which you want to merge a ticket. |
|
Ticket IDs |
Add the source Ticket ID which you want to merge. |
|
Target Comment |
Enter the comment for merging the source ticket. |
|
Target Comment Public |
Select whether the in-target ticket’s comment is public or private. |
|
Source Comment |
Enter the comment for merging with the target ticket. |
|
Source Comment Public |
Select whether the in-source comments are public. |
Soft deletes a ticket.
Required Permissions: read, write
|
Connection |
|
|
Ticket ID |
Enter the Ticket ID you want to delete. |
Deletes a ticket permanently.
Required Permissions: read, write
|
Connection |
|
|
Soft Delete or Soft + Hard Delete |
Select or map the option using which you want to delete the ticket:
Note: To delete a ticket permanently, you first need to soft delete the ticket. |
|
Ticket ID |
Enter the Ticket ID you want to delete. |
Uploads attachments for future use in a ticket.
Required Permissions: read, write
|
Connection |
|
|
Attachments |
Add the attachment details: File Name Enter (map) the file name. Data Enter (map) the file data. |
Checks whether new comments were made on a specified ticket.
Required Permissions: read
|
Connection |
|
|
Limit |
Enter the maximum number of comments Boost.space Integrator should return during one scenario execution cycle. |
Lists the Comments were made on a specified ticket.
Required Permissions: read
|
Connection |
|
|
Ticket ID |
Select or map a Ticket ID whose comments you want to list. |
|
Limit |
Enter the maximum number of comments Boost.space Integrator should return during one scenario execution cycle. |
Creates a ticket comment.
Required Permissions: read, write
|
Connection |
|||||||||||
|
Ticket ID |
Enter the Ticket ID to which you want to add a comment. |
||||||||||
|
Comment |
Add the comment details:
|
List the options of a ticket custom fieldA feature in Boost.space that allows you to define and manage data within each module according to your specific needs. More.
Required Permissions: read
|
Connection |
|
|
Custom Field ID |
Select or map the Custom Field ID whose options you want to list:
|
|
Limit |
Set the maximum number of field options Boost.space Integrator should return during one execution cycle. |
Creates or updates a drop-down ticket field option.
Required Permissions: read, write
|
Connection |
|
|
Custom Field ID |
Select or map the Custom Field ID whose options you want to list:
|
|
Create or Update |
Select or map the option whether you want to create or update the ticket. |
|
Option ID |
Select or map the Option ID whose details you want to update. |
|
Option Name |
Enter (map) the option name. For example, |
|
Option Value |
Enter (map) the option value. For example, |
Removes a drop-down ticket field option.
Required Permissions: read, write
|
Connection |
|
|
Custom Field ID |
Select or map the Custom Field ID whose option you want to delete:
|
|
Option ID |
Select or map the Option ID you want to delete. |
Checks whether new organizations were created.
Required Permissions: read
|
Connection |
|
|
Watch |
Select the option for the organizations you want to watch:
|
|
Filtering |
Add the filtering query to watch the organizations based on the specified query. For detailed information on setting up a filter, see the Zendesk documentation. The |
|
Limit |
Set the maximum number of organizations Boost.space Integrator should return during one scenario execution cycle. |
Retrieves all organizations.
Required Permissions: read
|
Connection |
|
|
Filter by User or Organization Name |
Select the option for the organizations you want to watch:
|
|
Filter by User ID |
Select or map the User ID whose organizations you want to list. |
|
Filter by Organization Name |
Enter (map) the name to list the organizations that match the specified name. |
|
Limit |
Set the maximum number of organizations Boost.space Integrator should return during one scenario execution cycle. |
Searches for an organization that matches the specified criteria.
Required Permissions: read
|
Connection |
|
|
Sort By |
Select or map the option to sort the organizations:
|
|
Sort Order |
Select or map the order in which you want to arrange the search results. For example, |
|
Filtering |
Enter (map) the filtering query to search the organizations that match the query. For detailed information on setting up a filter, see the Zendesk documentation. The |
|
Limit |
Set the maximum number of organizations Boost.space Integrator should return during one scenario execution cycle. |
Retrieves an organization.
Required Permissions: read
|
Connection |
|
|
Organization ID or Organization External ID |
Select or map the option to retrieve the details of the organization:
|
|
Organization ID |
Select or map the Organization ID whose details you want to retrieve. |
|
Organization External ID |
Select or map the Organization External ID whose details you want to retrieve. |
Creates a new organization.
Required Permissions: read, write
|
Connection |
|
|
Create or Create/Update |
Select or map the option for the action you want to perform:
|
|
Organization Name |
Enter (map) the organization name. The organization name is required for creating organizations and not for updating them. This field can be updated if combined with an existing organization ID or an existing external organization ID and must always be unique. |
|
Organization ID |
Select or map the Organization ID. |
|
External Organization ID |
Enter (map) the External Organization ID to identify the organization in the external systems. |
|
Domain Names |
Add the domain names for the organization. For example, |
|
Details |
Enter (map) any information about the organization. |
|
Notes |
Enter any additional information you would like to mention about the organization. |
|
Group ID |
Select the Group ID associated with the organization. New tickets from users in this organization are automatically put in this group. For example, |
|
Shared Tickets |
Select whether the organization has shared tickets. End users in this organization can see each other’s tickets. |
|
Shared Comments |
Select whether the organization has shared comments. End users in this organization can see each other’s comments on tickets. |
|
Tags |
Select or map the tags for the organization. |
|
Organizational Fields |
Add any additional fields about the organization. For example, |
Updates an existing organization.
Required Permissions: read, write
|
Connection |
|
|
Organization ID |
Select or map the Organization ID whose details you want to update. |
|
Organization Name |
Enter (map) the organization name. The organization name is required for creating organizations and not for updating them. This field can be updated if combined with an existing organization ID or an existing external organization ID and must always be unique. |
|
External Organization ID |
Enter (map) the External Organization ID to identify the organization in the external systems. |
|
Domain Names |
Add the domain names for the organization. For example, |
|
Details |
Enter (map) any information about the organization. |
|
Notes |
Enter any additional information you would like to mention about the organization. |
|
Group ID |
Select the Group ID associated with the organization. New tickets from users in this organization are automatically put in this group. For example, |
|
Shared Tickets |
Select whether the organization has shared tickets. End users in this organization can see each other’s tickets. |
|
Shared Comments |
Select whether the organization has shared comments. End users in this organization can see each other’s comments on tickets. |
|
Tags |
Select or map the tags for the organization. |
|
Organizational Fields |
Add any additional fields about the organization. For example, |
Deletes an organization.
Required Permissions: read, write
|
Connection |
|
|
Organization ID or Organization External ID |
Select or map the option through which you want to delete the organization. |
|
Organization ID |
Select or map the Organization ID you want to delete. |
|
Organization External ID |
Select or map the Organization External ID you want to delete. |
Checks whether new groups were created.
Required Permissions: read
|
Connection |
|
|
Watch |
Select the option for the groups you want to watch:
|
|
Filtering |
Enter (map) the query to watch the groups that match the specified query. For detailed information on setting up a filter, see the Zendesk documentation. The |
|
Limit |
Enter the maximum number of groups Boost.space Integrator should return during one scenario execution cycle. |
Retrieves all groups.
Required Permissions: read
|
Connection |
|
|
Filters |
Select or map the option to list the groups:
|
|
Filter by User ID |
Select or map the User ID whose groups you want to list. |
|
Limit |
Set the maximum number of groups Boost.space Integrator should return during one execution cycle. |
Retrieves a group.
Required Permissions: read
|
Connection |
|
|
Group ID |
Select or map the Group ID whose details you want to retrieve. |
Creates group.
Required Permissions: write
|
Connection |
|
|
Name |
Enter (map) a name for the group. |
|
Description |
Enter (map) the details of the group. |
Updates an existing group.
Required Permissions: read, write
|
Connection |
|
|
Group ID |
Select or map the Group ID whose details you want to update. |
|
Name |
Enter (map) a new name for the group. |
|
Description |
Enter (map) the details of the group. |
Deletes a group.
Required Permissions: read, write
|
Connection |
|
|
Group ID |
Select or map the Group ID you want to delete. |
Checks whether new users were created.
Required Permissions: read
|
Connection |
|
|
Watch |
Select the option for the users you want to watch:
|
|
Filtering |
Enter (map) the query to watch the users that match the specified query. For more information on setting up a filter, see the Zendesk documentation. The |
|
Limit |
Set the maximum number of users Boost.space Integrator should return during one scenario execution cycle. |
Retrieves all users, a group’s, or an organization’s users.
Required Permissions: read
|
Connection |
|
|
Filter by Group ID or Organization ID |
Select or map the option to search the users:
|
|
Organization ID |
Select or map the Organization ID whose users you want to list. |
|
Group ID |
Select or map the Group ID whose users you want to list. |
|
Filter by Default Role ID |
Select or map the Default Role ID of the users you want to list. |
|
Filter by Custom Role ID |
Select or map the Custom Role ID of the users you want to list. |
|
Limit |
Set the maximum number of users Boost.space Integrator should return during one execution cycle. |
Searches for a user that matches specified criteria.
Required Permissions: read
|
Connection |
|
|
Sort By |
Select or map the option to sort the users:
|
|
Sort Order |
Select or map the order in which you want to list the users. For example, |
|
Filtering |
Enter (map) the query to filter the users that match the specified query. For more information on setting up a filter, see the Zendesk documentation. The |
|
Limit |
Select the user role you are creating:
If you do not select a role for the user, the new user is assigned the role of the end-user. |
Get an existing user.
Required Permissions: read
|
Connection |
|
|
User ID or User External ID |
Select or map the option to retrieve the users:
|
|
User ID |
Select or map the User ID whose details you want to retrieve. |
|
User External ID |
Select or map the User External ID whose details you want to retrieve. |
Returns related information about the user specified by the given user ID. For example, the number of assigned tickets.
Required Permissions: read
|
Connection |
|
|
User ID |
Enter the User ID whose details you want to retrieve. |
Creates a user.
Required Permissions: read, write
|
Connection |
|
|
Create or Create/update |
Select or map the option to create or update a user:
|
|
User ID |
Select the User ID whose details you want to update. |
|
Name |
Enter the name of the user. |
|
|
Enter the email address of the user. |
|
External ID |
Enter (map) the External ID of the user to identify in external systems. |
|
Role |
Select the user role you are creating:
|
|
Ticket Registration |
Select or map the ticket access for the user:
|
|
Verified |
Select whether you want to send a verification mail to the user. |
|
Organization ID |
Select or map the Organization ID to which the user belongs. |
|
Details |
Enter (map) any additional information you want to store about the user. For example, |
|
Phone |
Enter the user’s phone number. |
|
Locale |
Enter (map) the BCP-47 compliant tag for the locale. |
|
Locale ID |
Enter (map) the locale ID of the user. This field is applicable if the locale is not available. |
|
Suspended |
Select whether the user is suspended. |
|
Tags |
Select or map the tags for the user. |
|
Time zone |
Enter (map) the time zone for the user. For more information on a valid time zone, click here. |
|
User fields |
Add the user fields. For example, |
Updates a user.
Required Permissions: read, write
|
Connection |
|
|
User ID |
Select the User ID whose details you want to update. |
|
Name |
Enter (map) the name of the user. |
|
|
Enter (map) a new email address of the user. This will not update the primary email but will add a secondary email. |
|
Role |
Select the user role you are creating:
If you do not select a role for the user, the new user is assigned the role of the end-user. |
|
External ID |
Enter (map) the External ID which you can link to Zendesk tickets to local records. |
|
Alias |
Enter (map) the alias name for the user. |
|
Verified |
Select whether you want to send a verification email to the user. |
|
Organization ID |
Select or map the Organization ID to which the user belongs. |
|
Details |
Enter (map) the details of the user. |
|
Notes |
Enter any additional information you would like to mention about the user. |
|
Phone |
Enter (map) the phone number of the user. |
|
External ID |
Enter (map) the External ID of the user to identify in external systems. |
|
Locale |
Enter (map) a BCP-47 compliant tag for the locale. |
|
Locale ID |
Enter (map) the language ID of the user. |
|
Suspended |
Select whether the user is suspended. |
|
Tag |
Enter (map) the tags to filter the user when searching. |
|
Ticket Restriction |
Select the access for tickets of the user:
|
|
Time Zone |
Enter (map) the time zone applicable to the user. For more information on a valid time zone, click here. |
|
User fields |
Add the user fields. For example, |
Deletes a user.
Required Permissions: read, write
|
Connection |
|
|
User ID or User External ID |
Select or map the option through which you want to delete the user:
|
|
User ID |
Select or map the User ID you want to delete. |
|
User External ID |
Select or map the User External ID you want to delete. |
Watches specific events configured by the user through Zendesk triggers or automation.
|
Webhook Name |
Enter a name for the webhook. |
See the Set Up Zendesk Webhooks section to add a webhook in your Zendesk account.
Checks whether new articles were created.
Required Permissions: read
|
Connection |
|
|
Watch |
Select the option for the articles you want to watch:
|
|
Limit |
Set the maximum number of results Boost.space Integrator should return during one execution cycle. |
Checks whether new comments were added to an article.
Required Permissions: read
|
Connection |
|
|
Article ID |
Select or map the Article ID whose comments you want to watch. |
|
Limit |
Set the maximum number of article comments Boost.space Integrator should return during one execution cycle. |
Checks whether new forum posts were created.
Required Permissions: read
|
Connection |
|
|
Filter by User or Topic |
Select or map the option for the forum posts you want to watch:
|
|
Filter by User |
Select or map the user whose forum posts you want to watch. |
|
Filter by Topic |
Select or map the option for which topic you want to watch:
|
|
Watch |
Select or map the option for the forum posts you want to watch:
|
|
Limit |
Set the maximum number of forum posts Boost.space Integrator should return during one execution cycle. |
Checks whether new comments were added to a forum post.
Required Permissions: read
|
Connection |
|
|
Filter by User or Post |
Select or map the option for the forum post comments you want to watch:
|
|
Filter by User |
Select or map the user whose forum posts comments you want to watch. |
|
Filter by Post |
Select or map the post whose forum posts comments you want to watch. |
|
Limit |
Set the maximum number of forum post comments Boost.space Integrator should return during one execution cycle. |
Checks whether new views were created.
Required Permissions: read
|
Connection |
|
|
Watch |
Select the option for the views you want to watch:
|
|
Limit |
Set the maximum number of views Boost.space Integrator should return during one execution cycle. |
Adds tags or replaces existing ticket, user, or organization tags.
Required Permissions: read, write
|
Connection |
|
|
Add, Replace or Remove |
Select or map the action you want to perform:
|
|
User or Organization or Ticket |
Select or map the option that you want to add, replace, or remove the tags:
|
|
User ID |
Select or map the user ID whose tags you want to add, replace, or remove. |
|
Organization ID |
Select or map the organization ID whose tags you want to add, replace, or remove. |
|
Ticket ID |
Select or map the ticket ID whose tags you want to add, replace, or remove. |
|
Tags |
Select or map the tags you want to add, replace, or remove. |
Retrieves any kind of object making your query.
Required Permissions: read
|
Connection |
|
|
Filtering |
Enter (map) the query for filtering the results you want to search. For more information on setting up a query, see the Zendesk documentation. |
|
Sort By |
Select or map the option to sort the search results:
|
|
Sort Order |
Select or map the order in which you want to arrange the search results:
|
|
Limit |
Set the maximum number of results Boost.space Integrator should return during one execution cycle. |
Performs an arbitrary authorized API Call.
Required Permissions: read, write
|
Connection |
|
|
URL |
Enter a path relative to For the list of available endpoints, refer to the Zendesk API Documentation. |
|
Method |
Select the HTTP method you want to use:
|
|
Headers |
Enter the desired request headers. You don’t have to add authorization headers; we already did that for you. |
|
Query String |
Enter the request query string. |
|
Body |
Enter the body content for your API call. |