Commit d3d6457a authored by Jason Colyer's avatar Jason Colyer
Browse files

Migrating from zapier to workato

parent d762aa30
Loading
Loading
Loading
Loading
+1 −0
Original line number Diff line number Diff line
@@ -27,6 +27,7 @@ These are scoped labels, meaning only one of them can ever be present on an issu
| `Zapier` | The issue relates to Zapier |
| `Calendly` | The issue relates to Calendly |
| `Salesforce` | The issue relates to Salesforce |
| `Workato` | The issue relates to Workato |

## Types of work labels

+29 −0
Original line number Diff line number Diff line
---
title: Workato
description: Operations documentation page for Workato
canonical_path: "/handbook/security/customer-support-operations/docs/workato/"
---

{{% pageinfo color="info" %}}

This is an informational page for Workato. It may not reflect the way we actually manage it.

If you are looking for information about maintaining it, please see [our workflows](../../workflows/)

{{% /pageinfo %}}

## What is Workato

According to [wikipedia](https://en.wikipedia.org/wiki/Workato):

> Workato is an American multinational software company that provides a cloud-based platform for automation, integration, and artificial intelligence (AI) orchestration across applications, data, and systems.

In a broader sense, Workato is a tool we utilize to enhance the functionality of many of our systems, such as Zendesk, GitLab.com, etc.

## Creating a recipe

For information on creating a recipe, please see [Workato's documentation](https://docs.workato.com/getting-started/build-first-recipe.html)

## Creating a connection

For information on creating a connection, please see [Workato's documentation](https://docs.workato.com/connections.html#connection-basics)
+0 −89
Original line number Diff line number Diff line
---
title: Zapier
description: Operations documentation page for Zapier
canonical_path: "/handbook/security/customer-support-operations/docs/zapier/"
---

{{% pageinfo color="info" %}}

This is an informational page for Zapier. It may not reflect the way we actually manage it.

If you are looking for information about maintaining it, please see [our workflows](../../workflows/)

{{% /pageinfo %}}

## What is Zapier

According to [wikipedia](https://en.wikipedia.org/wiki/Zapier):

> Zapier is a product that allows end users to integrate the web applications
> they use.

In a broader sense, Zapier is a tool we utilize to enhance the functionality of many of our systems, such as Zendesk, GitLab.com, etc.

## Creating a Zap

To create a zap, login to Zapier and click the black `Create Zap` button on the top-left of the page. This will bring up the zap editor.

The first thing to do on this page is determine the name, location, description, and timezone for your zap to use. To do this, click on the settings icon (gear icon) on the right-hand side of the page. You will then give your zap a name, pick the folder to have it in, add a description for the zap, and determine the timezone for the zap to use.

After doing all this, you will then begin building your zap. This can be a very involved process and take time to get the hang of, so reach out to your fellow Support Operations team members for assistance.

In general, the process will go like this:

1. Pick an action for the task to take
1. Fill out any action specific criteria
1. Test out the task
1. Add a new task
1. Repeats steps 1-3 for as many times as needed
1. Turn on zap once you are done

## Editing a Zap

{{% alert title="Tip" color="success" %}}
When making major edits, it is always preferred to turn the zap off first by clicking the slider in the top-right of the zap editor page.
{{% /alert %}}

To edit a zap, you will login to Zapier and locate the zap in question. You will then click on the zap's name to be brought to the zap editor. From here, you can make whatever changes are needed. As the changes auto-save, once you are done you can leave the page.

## Using Zapier Storage

When we need to utilize something that needs to be secret, such as a token, we utilize Zapier Storage. You would need a step in your Zap to get the secret from Zapier Storage. From there, your future steps need to use this to fetch the secret value. If using code blocks, you would do this by setting an input variable with the value of the secret (and then using that input variable in your code). Some examples are below (assuming an input variable name of `secret`):

```python
client = StoreClient(input.get('secret'))
value = client.get('foo')
return { "key": value }
```

```javascript
const store = StoreClient(inputData.secret);
const value = await store.get('foo');
return { result: value };
```

### Adding an item

To add a new item to Zapier Storage, you must use the storage secret (found in the Customer Support Operations 1Password Vault). With that in hand, you would do the following:

```bash
curl -X POST -ss "https://store.zapier.com/api/records?secret=SECRET_GOES_HERE" \
  -d '{"foo": "bar"}'
```

Replacing `SECRET_GOES_HERE` with the actual secret value.

### Editing an item

To edit an item in Zapier Storage, you would do the same action you did to create one. So if updating the key `foo` to have a value of `bar2`, you would do:

```bash
curl -X POST -ss "https://store.zapier.com/api/records?secret=SECRET_GOES_HERE" \
  -d '{"foo": "bar2"}'
```

Replacing `SECRET_GOES_HERE` with the actual secret value.

## Troubleshooting zap issues

To troubleshoot a zap, you will login to Zapier and locate the zap in question. You will then click the down arrow to the right of the zap and select `View Zap History` to see the usage log. From here, you can select events to see what was sent in and out of the zap itself.
+3 −3
Original line number Diff line number Diff line
@@ -53,7 +53,7 @@ We currently send out CES surveys on tickets that have been in the solved state

### CES Processor

This takes information sent by Zapier and processes it. It then checks the information against the ticket itself to determine if the request is valid. It currently checks:
This takes information sent by Workato and processes it. It then checks the information against the ticket itself to determine if the request is valid. It currently checks:

- The ticket ID is present
- The ticket itself exists
@@ -80,7 +80,7 @@ This is the actual survey form sent to customers. The exact link received depend
- [Zendesk US Government](https://support.gitlab.io/ces-survey/us-government.html)
- [Zendesk US Government sandbox](https://support.gitlab.io/ces-survey/us-government-sb.html)

Submissions from the form are sent to Zapier.
Submissions from the form are sent to Workato.

The location of the source project is [here](https://gitlab.com/gitlab-support-readiness/forms/ces-survey). This is mirrored to [here](https://gitlab.com/support/ces-survey).

@@ -96,6 +96,6 @@ These are used to store the CES survey numerical score.

These are used to create feedback issues for Support.

### Zapier
### Workato

This is used to receive submissions from the CES Survey and send them to the CES Processor.
+6 −6
Original line number Diff line number Diff line
---
title: Zapier
description: Operations workflows page for Zapier
canonical_path: "/handbook/security/customer-support-operations/workflows/zapier/"
title: Workato
description: Operations workflows page for Workato
canonical_path: "/handbook/security/customer-support-operations/workflows/workato/"
---

{{% alert title="Note" color="primary" %}}

Zapier changes are classified as ad-hoc. Once changes are made in Zapier, they are live.
Workato changes are classified as ad-hoc. Once changes are made in Workato, they are live.

This can mean changes can cause severe problems if you have not thoroughly tested them.

@@ -16,8 +16,8 @@ This can mean changes can cause severe problems if you have not thoroughly teste

{{% alert title="Note" color="danger" %}}

Always, always, ALWAYS perform thorough and complete testing for Zapier changes.
Always, always, ALWAYS perform thorough and complete testing for Workato changes.

{{% /alert %}}

Currently, changes to Zapier are made in Zapier iteself.
Currently, changes to Workato are made in Workato iteself.
Loading