Skip to main content

Integration Builder: Create Custom Integrations

Leverage Torq's custom integration builder to create tailored step and trigger integrations.

In addition to Torq's 200+ public integrations, you can build custom step and trigger integrations to connect with any application or service your organization uses. Custom integrations are available to everyone in your workspace once created.

You must have the Workspace Creator role or above to create a custom integration.

How to use

Create a custom step integration with custom parameters

  1. Open the integration builder: Go to Build > Integrations and click Create > Integration.

  2. Fill in the details:

    • Type: Select Steps.

    • Name: Enter the application or vendor name (e.g. Microsoft Outlook).

    • Description: Enter a brief description (e.g. Perform API calls from your Microsoft Outlook account).

    • Vendor logo: Enter the URL of the logo in PNG or SVG format, or upload the file.

    • Documentation link: Enter the link to the vendor's API documentation.

  3. Continue: Click Next. The Instance name parameter is added by default.

  4. Select authentication: Select Custom as the authentication method.

  5. Configure integration parameters: Click Add Parameter to add a new parameter, then configure the following fields:

    • Type: Select Short Text for non-sensitive data (URLs, usernames, etc.) or Secret for sensitive data (tokens, API keys, client secrets, etc.).

    • Name: Enter a name for the parameter.

    • (Optional) Description: Displayed as a tooltip above the parameter name.

    • (Optional) Placeholder: Displayed as an example inside the parameter field.

    • (Optional) Default value: Pre-filled when creating an instance.

    • Required: Check if the parameter must be filled in when creating an instance.

    • Displayed: Uncheck to hide the parameter from users when creating an instance. Requires a default value to be set.

  6. Continue: Click Next.

  7. Configure a test (optional): Under Test Setup, configure a connection test for the integration.

    • URL: Enter the vendor endpoint to send the test request to. Choose an endpoint that won't count against your API quota, as it is called each time someone tests their instance (e.g. https://login.microsoftonline.com/{{ .TENANT_ID }}/oauth2/v2.0/token).
      If the endpoint requires dynamic instance-specific values (e.g. {{.TENANT_ID}}), write the endpoint with a placeholder (e.g. {tenantID}), highlight it, click Assign to Existing Parameter, and select the corresponding parameter.

    • Method: Select the HTTP method required by the endpoint.

    • Authorization: Select the authorization type, None, Basic, Bearer, AWS SigV4, or Akamai EdgeGrid, and add any required headers.

    • (Optional) Content type: Specify the content type as defined in the vendor's API documentation.

    • (Optional) Body: Include a request body if required by the API call.

    • (Optional) Timeout: Enable if the request may take longer than expected.

    • (Optional) Skip SSL Verification: Enable if recommended by the vendor's API documentation.

  8. Publish: Click Save and Publish.

  9. (Optional) Create an instance: Click Create Instance to navigate to the new integration and set it up, or click Edit to make further changes.

After creating your custom step integration, create custom steps for it by going to Build > Integrations > Create > Step.

Create a custom step integration with OAuth 2.0

  1. Open the integration builder: Go to Build > Integrations and click Create > Integration.

  2. Fill in the details: Follow steps 2–3 from Create a custom step integration with custom parameters.

  3. Select authentication: Select OAuth 2.0 as the authentication method.

  4. Select grant type:

    • Client Credentials: Automatically adds Token URL, Client ID, and Client Secret as required parameters.

    • Authorization Code: Automatically adds Auth URL, Token URL, Client ID, and Client Secret as required parameters. The callback URL is added automatically and cannot be edited.

  5. (Optional) Add parameters: Click Add Parameter to add any additional parameters required by the integration.

    • The Instance name parameter is added by default.

    • OAuth-specific parameter types: Audience, Scopes, Resources, or Custom.

    • Type: Select Short Text for non-sensitive data (URLs, usernames, etc.) or Secret for sensitive data (tokens, API keys, client secrets, etc.).

      • Short Text: For non-sensitive data (URLs, usernames, etc.)

      • Secret: For sensitive data (tokens, API keys, client secrets, etc.)

    • (Optional) Description: Displayed as a tooltip above the parameter name.

    • (Optional) Placeholder: Displayed as an example inside the parameter field.

    • (Optional) Default value: Pre-filled when creating an instance.

    • Required: Check if the parameter must be filled in when creating an instance.

    • Displayed: Uncheck to hide the parameter from users when creating an instance. Requires a default value to be set.

  6. Continue: Click Next.

  7. (Optional) Configure a test: Follow step 7 from Create a custom step integration with custom parameters.

  8. Publish: Click Save and Publish.

  9. (Optional) Create an instance: Click Create Instance to navigate to the new integration and set it up, or click Edit to make further changes.

Create a custom trigger integration

  1. Open the integration builder: Go to Build > Integrations and click Create > Integration.

  2. Fill in the details:

    • Type: Select Trigger.

    • Name: Enter the application or vendor name (e.g. Microsoft Outlook).

    • Description: Enter a brief description (e.g. Receive alerts from your Microsoft Outlook account).

    • Vendor logo: Enter the URL of the logo in PNG or SVG format, or upload the file.

    • Documentation link: Enter the link to the vendor's API documentation.

  3. Publish: Click Save and Publish.

  4. (Optional) Create an instance: Click Create Instance to navigate to the new integration and set it up, or click Edit to make further changes.

Did this answer your question?