Connectors / Service / Welcome

Welcome provide marketing management software & content marketing services to marketing teams who want to elevate performance. (updated: 1623401357743)

Welcome

Welcome provides marketing management software & content marketing services to marketing teams who want to elevate performance.

Overview

Supercharge your team's ability to plan, execute, and manage exceptional campaigns and content, and elevate the performance of marketing with marketing management software and content marketing services from Welcome.

API INFO: The Base URL used for the Welcome connector is https://api.welcomesoftware.com/v3. More information can be found on their main API documentation (v3.0) site. This is where users will also be able to find the API Limitations page.

Authentication

IMPORTANT!: If you set up a new authentication while another one is in use, it will causethe refresh token of the authentication already in use to fail (once the access token hasexpired). A new authentication will have to be created each time.

Within the workflow builder, highlight the Welcome connector.

In the Welcome connector properties panel to the right of the builder, click on the Authenticate tab and the 'Add new authentication' button.

welcome-auth

This will result in a Tray.io authentication pop-up modal. The first page will ask you to name your authentication and select the type of authentication you wish to create ('Personal' or 'Organisational').

The next page asks you for your 'Client ID' and 'Client Secret' credentials.

welcome-popup

In order to get these fields, head to the Welcome dashboard. Click on your username logo in the navigation bar and select the 'App & Webhooks' option from the side menu which appears.

welcome-auth-step-1

To get the 'Client ID' and 'Client Secret' credentials, click on your app.

welcome-auth-step-2

They are listed under the 'Apps' tab.

welcome-auth-step-3

Once you have added these fields to your Tray.io authentication pop-up window, click the 'Create authentication' button.

Go back to your settings authentication field (within the workflow builder properties panel), and select the recently added authentication from the dropdown options now available.

Your connector authentication setup should now be complete.

Welcome Trigger

If you wish your workflow to be kicked off by a particular action in Welcome, you can use the Welcome Trigger.

The Welcome trigger allows you to receive notifications and trigger workflows when given events occur associated with the selected trigger operation.

Trigger Operations available:

  • Asset added

  • Asset removed

  • Asset modified

Webhook Setup

Select the Welcome trigger. This can be done either at the create new workflow stage or updated within the workflow builder itself.

Highlight the Welcome trigger. In the Welcome trigger properties panel to the right of the builder, click on the Authenticate tab and the 'Add new authentication' button.

At this stage, you can create a new authentication using the steps specified in the Authentication section above.

Or you can select the already created authentication from the available list.

To finish setting up your trigger you will need to register the trigger through the Welcome API under the previous 'Apps & Webhooks' section of the Welcome dashboard.

Click the 'Register a Webhook' button. The next page will ask you for the 'Callback URL' and 'Secret'. Leave these blank for now but save the page for later use.

welcome-register-webhook-blank

To get your 'Callback URL' head back to your Tray builder, click the ellipses in the top left corner and click 'Workflow settings'.

welcome-workflow-settings

Copy the 'Workflow public URL'.

welcome-workflow-url

Head back to your Welcome dashboard, and paste this into the 'Callback URL' field within the Apps and Webhook page.

welcome-register-webhook

The 'Secret' is created by you and must match the secret used when registering the webhooks. Enter your secret into the Welcome trigger section and be sure to tick all the events you want this webhook to listen to.

Lastly, to finish your trigger set up, head back to your workflow, enter your 'Secret', and click enable.

welcome-finished-setup

You can check the input and output for your trigger using the Debug tab.

welcome-trigger-debug

WEBHOOKS: As this uses a webhook as its operation type, you will also need to integrate it with your Welcome account, in order to complete the authentication process.

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.

Using the Raw HTTP Request ('Universal Operation')

As of version 1.0, you can effectively create your own operations.

This is a very powerful feature which you can put to use when there is an endpoint in Welcome which is not used by any of our operations.

To use this you will first of all need to research the endpoint in the Welcome API documentation v3.0, to find the exact format that Welcome will be expecting the endpoint to be passed in.

Note that you will only need to add the suffix to the endpoint, as the base URL will be automatically set (the base URL is picked up from the value you entered when you created your authentication).

The base URL for Welcome is: https://api.welcomesoftware.com/v3

For example, say that the 'Get Assets' operation did not exist in our Welcome connector, and you wanted to use this endpoint. You would use the Welcome API docs to find the relevant endpoint - which in this case is a GET request called: /assets.

More details about this endpoint can be found here.

welcome-get-url

As you can see, there is also the option to include a query parameter, should you wish to do so. So if you know what your method, endpoint, and details of your query parameters are, you can return a list of the images in your Welcome library with the following settings:

Method: GET

Endpoint: assets

Query Parameter: Key: type Value: image

Body Type : Raw : { "none" : "null" }

Final outcome being: https://api.welcomesoftware.com/v3/assets?type=image

welcome-raw-http

Example Usage

TRAY POTENTIAL: Tray.io is extremely flexible. By design there is no fixed way of working with it - you can pull whatever data you need from other services and work with it using our core and helper connectors. This demo which follows shows only one possible way of working with Tray.io and the welcome connector. Once you've finished working through this example please see our Introduction to working with data and jsonpaths page and Data Guide for more details.

Below is an example of a way in which you could potentially use the Welcome connector, to update an asset (for example your company's logo) within your Welcome library.

EXTRA AUTHS: In order to complete this workflow, you will also need to be authenticated with the Google Drive connector.

  1. Setup using a manual trigger.

  2. Download your chosen file from your Google Drive using the Google Drive connector.

  3. Use the Welcome connector to update an existing asset in your Welcome library by uploading your file (downloaded in the previous step) as a new asset version.

  4. Update your new asset version with additional information.

Your completed workflow should look similar to this:

welcome-complete-workflow

1 - Setup Trigger & Download File from your Google Drive Account

Select the Manual trigger from the trigger options available.

welcome-manual-trigger

From the connectors panel on the left, add a Google Drive connector to your workflow. Set the operation to 'Download file'.

welcome-step-1

As you can see, the 'File ID' field is required.

To get this field, navigate to your chosen image in your Google Drive account and click on the Hamburger icon (3 vertical dots) on the top right corner.

Next, select 'Share' from the navigation menu which appears and select the 'Copy link' option.

welcome-step-1-file-id

Your file ID can be found in the copied link URL, and will look like this: https://drive.google.com/file/d/yourfileid/view?usp=sharing

Feel free to re-name your steps as you go along to make things clearer for yourself and other users. The operation names themselves often suffice.

You have now configured your workflow to be manually triggered and to download a file from your Google Drive.

2 - Upload a New Asset Version

Next, search for the Welcome connector within your connector panel, and drag it into your workflow as your next step. Set your operations to 'Upload asset version'.

As you can see, the 'Asset ID', 'File', and 'Title' fields are required.

You can select the name of the file you wish to create a new version of from the drop-down list underneath 'Asset ID'.

Next, use the file mapping icon (found next to the File input field, within the properties panel) to generate the connector-snake.

While hovering over the 'Download file' step (with the tail end of the connector-snake), select file from the list of output properties displayed. This will auto-populate a jsonpath within your list input field, and update the type selector to jsonpath.

Finally, you can give your file a title - this can be whatever you want!

For more clarification on the pathways you have available, open the Debug panel to view your step's Input and Output.

JSONPATHS: For more information on what jsonpaths are and how to use jsonpaths with Tray.io, please see our Intro page and Data Guide for more details.

CONNECTOR-SNAKE: The simplest and easiest way to generate your jsonpaths is to use our feature called the Connector-snake. Please see the main page for more details.

welcome-step-2-loop

If you head to your Welcome library, you will see that your existing file has now been updated with the new version you just uploaded.

welcome-step-2-UI

3 - Update Asset Information

The last step is to drag another Welcome connector into your workflow. Set the operation to 'Update image'. As you can see, the 'ID' field is required.

PLEASE NOTE: In this case, the asset type we are working with is an image. If you have useda different asset type you will have to select the related operation. For example, if you areusing a PDF file, you would select the 'Update raw file' operation instead.

In order to specify the image you want to update, start by using the ID mapping icon (found next to the ID input field, within the properties panel) to generate the connector-snake.

While hovering over the 'Upload asset version' step (with the tail end of the connector-snake), select asset_id from the list of output properties displayed. This will auto-populate a jsonpath within your list input field, and update the type selector to jsonpath.

Now that we have selected the correct asset, we want to give it some additional information.

You could give your asset a new title here, but as we already gave it a title in the previous step we will leave it empty.

To begin, select 'Add to Labels' underneath the 'Labels' input field. Next, pick an option from the drop-down list underneath the 'Group ID' input field.

Finally, select 'Add to Value IDs' and choose any of the options with the 'Group ID' you selected, prepending the option.

welcome-step-3
welcome-debug-panel

The end result in your UI should look something like this:

welcome-step-3-UI

You have now successfully completed this tutorial, where you have learned how to download a file from Google Drive inside of a Tray workflow and use it to create a new asset version in your Welcome library.

BEST PRACTICES: Whenever you do decide to create your own workflow, please make sure you take a look at our managing data best practices guide.

All Operations

Latest version:

3.0

Create/ Upload task comment

Create a task sub step comment.

Delete image

Delete an image.

Delete raw file

Delete a raw file.

Delete video

Delete a video.

Get article

Get an article by ID.

Get campaign

Get a campaign data.

Get image

Get an image by ID.

Get raw file

Get a raw file by ID.

Get task

Get a task by ID.

Get task article data

Get an article associated with the task identified by Task ID.

Get task brief

Get brief of the task.

Get task comment

Get a task sub step comment.

Get task custom field

Get a custom field of a task.

Get task external work

Get the external work information of a task external sub step.

Get task image data

Get an image associated with the task identified by Task ID.

Get task raw files data

Get a raw file associated with the task identified by Task ID.

Get task sub step

Get the sub step of a task.

Get task video data

Get a video associated with the task identified by Task ID.

Get video

Get a video by ID.

List asset versions DDL

List assets

Get a list of assets.

List assets DDL

List label group values DDL

List label groups DDL

List label groups and values

Get a list of label groups and corresponding values.

List task assets

Get the list of the assets/contents of a task.

List task assets DDL

List task attachments

Get the list of the attachments of a task.

List task comments

Get the list of the comments of a task sub step.

List task custom field choices

Get the list of the choices of a custom field in a task.

List task custom fields

Get the list of custom fields added to a task.

List task steps DDL

Raw HTTP request (advanced)

Perform a raw HTTP request with some pre-configuration and processing by the connector, such as authentication.

Update image

Update an image.

Update raw file

Update a raw file.

Update task custom field

Update a custom field of a task. Currently supports update on the following types: text_field, multi_line_text_field, checkboxes, dropdown, multiple_choice, date_field, rich_text_field.

Update task external work

Update the external work information of a task external sub step.

Update task sub step

Update the sub step associated with an external work.

Update video

Update a video.

Upload asset version

Upload a new version of an existing library asset. Only supports adding a new version to "images, "videos" and "raw files" type assets.

Upload task asset

Add a new asset to task. Supports only images, videos and raw files.

Upload task asset draft

Add a new draft to a task asset. Supports adding draft to only images, videos and raw files type task assets.