DEALHUB

*[*Note:

• Make sure you duplicate this template for your personal use. Do not edit anything in the template.
• You should remove or replace all the instructions provided in square brackets along with this one before you publish your doc. These are for your understanding and are not to be published with the documentation.
• Add relevant callouts wherever needed. For a complete list of callouts, refer to this Notion page. ]

Overview

[CONNECTOR NAME] is...... [Technical description of the product's capabilities. Please refer to Dropbox and Stripe docs for examples.]

**API Information **

*[****OPTIONAL: ***REMOVE this API Information section if not applicable] The Base URL used for the [CONNECTOR NAME] connector is [BASE URL HERE IN BOLD]. More information can be found on their main [API documentation (v[API VERSION NUMBER HERE]) - LINK TO DOCUMENTATION HERE] site.

Authentication

Within the builder, click on the [CONNECTOR NAME] connector to display the connector properties panel. Select the 'Auth' tab and click on the 'New authentication' button. In the Tray.io authentication pop-up modal, name the authentication in a way that will quickly identify it within a potentially large list. For example, whether it is a Sandbox or Production auth, etc. Consider who/ how many people will need access to this authentication when choosing where to create this authentication ('Personal' or 'Organisational'). The second page asks you for your 'XXXXXX' and 'XXXXXX' ............. ..... credentials. [IMAGE: New authentication POP-UP MODAL] To get these fields, head to the [CONNECTOR NAME] dashboard. Click on the ....................... [IMAGE: AUTH STEP 1] To get the ......................., head to ....................... [IMAGE: AUTH STEP 2] To get the ......................., head to ....................... [IMAGE: AUTH STEP 3] *[****INCLUDE ***more images and steps as necessary - clearer is always better.] Once you have added these fields to your Tray.io authentication pop-up window, click the 'Create authentication' button.  Your connector authentication setup should now be complete.

[CONNECTOR NAME] Trigger

*[****OPTIONAL: ***REMOVE entire Trigger section if not applicable] The [CONNECTOR NAME] trigger allows you to receive notifications and trigger workflows when given events occur associated with the selected trigger operation.

Trigger Operations available:

• XXXXXXX
• XXXXXXX
• XXXXXXX

Webhook Setup

Select the [CONNECTOR NAME] trigger. This can be done at the create new workflow stage or updated within the workflow builder itself. Highlight the [CONNECTOR NAME] trigger. In the[CONNECTOR NAME] trigger properties panel to the right of the builder, click on the Authenticate tab and the 'Add new authentication' button. [IMAGE: TRIGGER 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 'XXXXXX' and 'XXXXXX' .................. credentials. *[****IMAGE: ***TRIGGER AUTH POPUP] [Note: IF 'Webhook' is available, demo using the following as a template explanation, otherwise, update/ explain as you see fit ]

Follow the instructions above to authenticate your trigger. Select 'Webhook' as the event you wish your trigger to listen to in order to set off the workflow itself. *[***IMAGE: **** WEBHOOK TRIGGER STEP 1] WEBHOOKS: As this uses a webhook as its operation type, you will need to set the webhook in your [CONNECTOR NAME] admin UI.

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.

Notes on using [Connector Name]

[Operation name or issue title]

[Explanation]

[Operation name or issue title]

[Explanation]

Using the Raw HTTP Request ('Universal Operation')

As of version X.X, you can effectively create your own operations. This is a powerful feature that you can use when there is an endpoint in [CONNECTOR NAME] that is not used by any of our operations. To use this, you will first of all need to research the endpoint in the [CONNECTOR NAME - CHANGE URL TO API DOCS URL] API documentation v[API DOCS VERSION] to find the exact format that [CONNECTOR NAME] will be expecting the endpoint to be passed in. For example, say that the 'XXXXXX' operation did not exist in our [CONNECTOR NAME] connector, and you wanted to use this endpoint. You would use the [CONNECTOR NAME] API docs to find the relevant endpoint - which in this case is a [METHOD] request called: /XXXXXX.*** *** More details about this endpoint can be found [API DOCS URL - TEXT SHOULD SAY "here"]. [IMAGE:* Your API CALL]* Based on the information provided in the above API call doc, you need to configure the following attributes on your Tray platform: [From the below attributes, include only those that apply to your API call]

• Method: XXXXXX
• **URL: *****[****If you need to provide only an Endpoint or a Full URL will depend upon the set authentication and the environment you want your API to work. * *If your auth contains an appropriate base URL, you can simply provide an Endpoint.]  *
  • **Endpoint / Full URL: XXXXXX **[Include only one option as per requirement]
• **Headers: **XXXXXX
• **Query parameters: **XXXXXX
• Body Type: XXXXXX [IMAGE: RAW HTTP operation on Tray platform] Once the API call is executed successfully, you should get the following results: [IMAGE: RAW HTTP operation output on Tray platform]

Example Usage

*[Reference docs: Accelevents and *Fullstory ]

Below is an example of a way in which you could potentially use the [CONNECTOR NAME] connector, to ....................... The overall logic of the workflow is: [DETAILED DESCRIPTION OF STEPS]

1. Setup using a manual trigger and .......................
2. .......................
3. .......................
4. ....................... Your completed workflow should look similar to this: *[****IMAGE: ***COMPLETED WORKFLOW]

Step-by-step Explanation

[To learn how to use accordions, refer to this Notion page.] ***[Note: ***

• Do not edit the below accordion. Create a new one and delete this one from your connector doc.
• Make sure you add an image in each accordion item for each step in your workflow.]