Skip to content
This repository was archived by the owner on Nov 10, 2021. It is now read-only.

User fields and error correction #20

Open
Stragis wants to merge 1 commit into
base: master
Choose a base branch
from
Open

User fields and error correction #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
116 changes: 58 additions & 58 deletions LICENSE
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,58 +1,58 @@
Copyright 2013 Zendesk

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Capitalized terms used herein have the meaning set forth in the Zendesk, Inc.
(“Zendesk”) Terms of Service (available at www.zendesk.com/company/terms) (the “Terms”).
The software made available herein constitutes “ZendeskLabs Software” which may be
implemented to enable features or functionality to be utilized in connection with a
subscription to the Service.
Notwithstanding anything to the contrary set forth in the Terms or any other
agreement by and between you and Zendesk, ZendeskLabs Software is provided
“AS IS” and on an “AS AVAILABLE” basis, and that Zendesk makes no warranty
as to the ZendeskLabs Software.

ZENDESK DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE,
NONINFRINGEMENT AND THOSE ARISING FROM A COURSE OF DEALING OR USAGE OF TRADE
RELATED TO THE ZENDESKLABS SOFTWARE, ITS USE OR ANY INABILITY TO USE IT OR
THE RESULTS OF ITS USE.

Use of ZendeskLabs Software is subject to the following risks and conditions:
(i) the ZendeskLabs Software is not an component of the Service that
has been designed for commercial release for by Zendesk;

(ii) the ZendeskLabs Software may not be in final form and may contain errors,
design flaws or other problems; (iii) the ZendeskLabs Software is not expected to
function fully or adequately upon installation, and it is expected and anticipated that
further testing, modification and development may be necessary to make the
ZendeskLabs Software functional;

(iv) it may not be possible to make the ZendeskLabs Software functional;

(v) use of the ZendeskLabs Software may result in unexpected results, loss of data,
project delays or other unpredictable damage or loss; and

(vi) Zendesk is under no obligation to release and/or offer for sale commercial
versions of the ZendeskLabs Software, and Zendesk has the right to unilaterally
abandon development or availability of the ZendeskLabs Software at any time and
without any obligation or liability to You. You further agree that Zendesk shall
have no obligation to correct any bugs, defects or errors in the ZendeskLabs Software
or otherwise to support or maintain the ZendeskLabs Software.

If you elect to utilize any ZendeskLabs Software, you are agreeing to release Zendesk
from any claim with regard to the ZendeskLabs Software, its operation, availability or
its failure to operate or be available. Without limiting the generality of the foregoing,

You acknowledge and agree that neither the use, availability nor operation of any
ZendeskLabs Software shall be subject to any service level commitment applicable to the Service.
Copyright 2013 Zendesk
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Capitalized terms used herein have the meaning set forth in the Zendesk, Inc.
(“Zendesk”) Terms of Service (available at www.zendesk.com/company/terms) (the “Terms”).
The software made available herein constitutes “ZendeskLabs Software” which may be
implemented to enable features or functionality to be utilized in connection with a
subscription to the Service.
Notwithstanding anything to the contrary set forth in the Terms or any other
agreement by and between you and Zendesk, ZendeskLabs Software is provided
“AS IS” and on an “AS AVAILABLE” basis, and that Zendesk makes no warranty
as to the ZendeskLabs Software.
ZENDESK DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE,
NONINFRINGEMENT AND THOSE ARISING FROM A COURSE OF DEALING OR USAGE OF TRADE
RELATED TO THE ZENDESKLABS SOFTWARE, ITS USE OR ANY INABILITY TO USE IT OR
THE RESULTS OF ITS USE.
Use of ZendeskLabs Software is subject to the following risks and conditions:
(i) the ZendeskLabs Software is not an component of the Service that
has been designed for commercial release for by Zendesk;
(ii) the ZendeskLabs Software may not be in final form and may contain errors,
design flaws or other problems; (iii) the ZendeskLabs Software is not expected to
function fully or adequately upon installation, and it is expected and anticipated that
further testing, modification and development may be necessary to make the
ZendeskLabs Software functional;
(iv) it may not be possible to make the ZendeskLabs Software functional;
(v) use of the ZendeskLabs Software may result in unexpected results, loss of data,
project delays or other unpredictable damage or loss; and
(vi) Zendesk is under no obligation to release and/or offer for sale commercial
versions of the ZendeskLabs Software, and Zendesk has the right to unilaterally
abandon development or availability of the ZendeskLabs Software at any time and
without any obligation or liability to You. You further agree that Zendesk shall
have no obligation to correct any bugs, defects or errors in the ZendeskLabs Software
or otherwise to support or maintain the ZendeskLabs Software.
If you elect to utilize any ZendeskLabs Software, you are agreeing to release Zendesk
from any claim with regard to the ZendeskLabs Software, its operation, availability or
its failure to operate or be available. Without limiting the generality of the foregoing,
You acknowledge and agree that neither the use, availability nor operation of any
ZendeskLabs Software shall be subject to any service level commitment applicable to the Service.
201 changes: 112 additions & 89 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,89 +1,112 @@
:warning: *Use of this software is subject to important terms and conditions as set forth in the License file* :warning:

# URL Builder App

## Description:

A Zendesk App to help you generate links for agents.

## Instructions:

1. Download a [.zip of this app](https://github.com/zendesklabs/url_builder_app/archive/master.zip)
2. Navigate to your Zendesk Admin's Apps -> Manage page
3. Click `Upload App`
4. Enter a descriptive name of your choosing, and upload this .zip
5. Click `Upload`
6. Confirm the title, the second box is for the `json`, described below.
7. Optionally enable role restrictions if these URLs are not appropriate for all agents.
8. Once your .json is in place, click `Install`.
9. Open a new browser to test your results.

## JSON Array of URLs:

The following is an example of what can be entered into this app's settings:

```javascript
[
{
"title": "First Title",
"url": "http://example.com/?name={{ticket.requester.name}}"
},
{
"title": "Second Title (with custom field)",
"url": "http://example.com/?custom={{ticket.custom_field_424242}}"
}
]
```

This example will generate the following HTML inside the app:
```html
<ul>
<li>
<a href="http://example.com/?name=Robert C.Martin">First Title</a>
</li>
<li>
<a href="http://example.com/?custom=secretRocketLaunchCodes">Second Title (with custom field)</a>
</li>
</ul>
```

### Available Placeholders
* {{ticket.id}} //not available for new tickets
* {{ticket.description}}
* {{ticket.requester.id}}
* {{ticket.requester.name}}
* {{ticket.requester.email}}
* {{ticket.requester.externalId}}
* {{ticket.requester.firstname}}
* {{ticket.requester.lastname}}
* {{ticket.requester.user_fields.YYY}} = custom user fields can be used
* {{ticket.assignee.user.id}}
* {{ticket.assignee.user.name}}
* {{ticket.assignee.user.email}}
* {{ticket.assignee.user.externalId}}
* {{ticket.assignee.user.firstname}}
* {{ticket.assignee.user.lastname}}
* {{ticket.assignee.group.id}}
* {{ticket.assignee.group.name}}
* {{ticket.custom_field_XXXXXXX}} // XXXXXXX = custom field id
* {{ticket.organization.organization_fields.XXXXXXX}} // XXXXXXX = Field key, default is field name
* {{current_user.id}}
* {{current_user.name}}
* {{current_user.email}}
* {{current_user.externalId}}
* {{current_user.firstname}}
* {{current_user.lastname}}

### Making changes

If you wish to change the output, locate the app by looking for the name you choose in step 4 above. Use the widget to `Change Settings`

<img width="195" src="https://github.com/watchmanmonitoring/url_builder_app/raw/master/assets/app-settings-change.png" />


## Contribution

Improvements are always welcome. To contribute, please submit detailed Pull Requests.

## Screenshot(s):
![screenshot-1](/assets/screenshot.png)
:warning: *Use of this software is subject to important terms and conditions as set forth in the License file* :warning:

# URL Builder App

## Description:

A Zendesk App to help you generate links for agents.

## Instructions:

1. Download a [.zip of this app](https://github.com/zendesklabs/url_builder_app/archive/master.zip)
2. Navigate to your Zendesk Admin's Apps -> Manage page
3. Click `Upload App`
4. Enter a descriptive name of your choosing, and upload this .zip
5. Click `Upload`
6. Confirm the title, the second box is for the `json`, described below.
7. Optionally enable role restrictions if these URLs are not appropriate for all agents.
8. Once your .json is in place, click `Install`.
9. Open a new browser to test your results.

## JSON Array of URLs:

The following is an example of what can be entered into this app's settings:

```javascript
[
{
"title": "First Title",
"url": "http://example.com/?name={{ticket.requester.name}}"
},
{
"title": "Second Title (with custom field)",
"url": "http://example.com/?custom={{ticket.custom_field_424242}}"
}
]
```

This example will generate the following HTML inside the app:
```html
<ul>
<li>
<a href="http://example.com/?name=Robert C.Martin">First Title</a>
</li>
<li>
<a href="http://example.com/?custom=secretRocketLaunchCodes">Second Title (with custom field)</a>
</li>
</ul>
```

### Available Placeholders

#### Ticket sidebar

* {{ticket.id}} //not available for new tickets
* {{ticket.description}}
* {{ticket.requester.id}}
* {{ticket.requester.name}}
* {{ticket.requester.email}}
* {{ticket.requester.external_id}}
* {{ticket.requester.firstname}}
* {{ticket.requester.lastname}}
* {{ticket.requester.user_fields.YYY}} = custom user fields can be used
* {{ticket.assignee.user.id}}
* {{ticket.assignee.user.name}}
* {{ticket.assignee.user.email}}
* {{ticket.assignee.user.external_id}}
* {{ticket.assignee.user.firstname}}
* {{ticket.assignee.user.lastname}}
* {{ticket.assignee.group.id}}
* {{ticket.assignee.group.name}}
* {{ticket.custom_field_XXXXXXX}} // XXXXXXX = custom field id
* {{ticket.organization.organization_fields.XXXXXXX}} // XXXXXXX = Field key, default is field name
* {{current_user.id}}
* {{current_user.name}}
* {{current_user.email}}
* {{current_user.external_id}}
* {{current_user.firstname}}
* {{current_user.lastname}}

#### User sidebar

* {{user.id}}
* {{user.name}}
* {{user.email}}
* {{user.phone}}
* {{user.external_id}}
* {{user.firstname}}
* {{user.lastname}}
* {{user.user_fields.YYY}} = custom user fields can be used
* {{user.organization.id}} (if user belongs to multiple organizations, only the default one will be used)
* {{user.organization.name}}
* {{user.organization.external_id}}
* {{user.organization.organization_fields.XXXXXXX}} = custom organization fields can be used


### Screenshots

![](/assets/screenshot.png)

### Making changes

If you wish to change the output, locate the app by looking for the name you choose in step 4 above. Use the widget to `Change Settings`

<img width="195" src="https://github.com/watchmanmonitoring/url_builder_app/raw/master/assets/app-settings-change.png" />


## Contribution

Improvements are always welcome. To contribute, please submit detailed Pull Requests.

## Screenshot(s):
![screenshot-1](/assets/screenshot.png)
4 changes: 2 additions & 2 deletions app.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
.btn {
width: 85%;
.btn {
width: 85%;
}
Loading