Requesting New Automations Using Spark Forms – AVRL

This article outlines the steps to request a new automation, securely submit your Spark Form, and move your build into intake.

Before you start

Which automation are you requesting?

AVRL builds two kinds of automation, and the Spark form is different for each. Select yours below - this guide will show only the steps that apply to you.

On-PortalTMS-Based Spot Bot

Signs in to your TMS website and navigates the screens the way a person would, submitting spot rates directly. Choose this when your TMS is web-based, or when you don't have API access.

Selected - showing this guide

API-BasedHyperY / APIGlue Automation

Connects through your TMS's API - incoming (HyperY - real time shipments) or outgoing (APIGlue - non-real time shipments). Choose this when your TMS offers API access; it's the faster, more resilient connection.

Select this guide

Not sure which fits? Ask us on a ticket before you request the Spark. First API connection? Read First-Time TMS API Connection Instructions - it covers the credentials your TMS provider will need to issue.

Step 1 of 5

Request your Spark

Requesting a Spark takes just a few quick steps in the AVRL Support Portal. Please submit a separate request for each account you want to automate.

Go to support.avrl.io

Click Submit a request, top right.
Choose the Spark option

Select Request a Spark for New Build.

support.avrl.io

Pick Request a Spark for New Build - one account per request from the issue dropdown.
Complete the request fields

Submitting this form creates your build ticket. All updates, questions, and communication related to the build will remain in this ticket.

Cachet tree nameNew build means no tree yet. Enter "n/a".

TMS Namee.g. Mercury Gate, E2Open, Blue Yonder.

API Based or on PortalSelect on Portal.Select API Based.
Describe your request and submit

One line is enough, e.g. "Please issue a spark for a new on portal bot for dhl, mercury gate.""Please issue a spark for a new API automation for dhl, mercury gate." Then select Submit.

No usernames or passwords here. Tickets with credentials get purged. They belong in the Spark Form only.

Step 2 of 5

Watch your email

Two things happen after you submit, and only the second needs you:

Your ticket activates

If you have three or fewer active tickets, activation is typically immediate. Otherwise, the request will remain in your queue until it reaches the active position.
The Spark email arrives

Once the ticket activates, the requester will receive a Spark email. This email is sent only to the person who submitted the request.

from: AVRL-Spark-Manager

The Spark Fillout Request email - the blue Spark Intake Form link opens your form.

Step 3 of 5

Sign in with your Supergen ID

Username: company name (lowercase, as shown in Generation Studio) + "/" + work email. No spaces.

Password: your AVRL SuperGeneration (Supergen) password.

Example companyname/you@companyname.com

Spark Intake Form - sign-in

The Spark form sign-in card asking for your AVRL SuperGeneration ID

The sign-in screen. The username field shows the expected format: companyname/youremail@email.com.

Step 4 of 5 On-Portal guideAPI guide

Fill the On-Portal form

In the Select TMS dropdown, choose Web-based TMS - this sets up the rest of the form. Then work through the fields:

Customer Webhook URLPaste your Teams webhook. If you review load entries through your datastore or Periscope instead, select See load entries in DB instead of webhook?

TMS URL + credentialsEnter the TMS login URL, along with the username and password the bot should use.

Bot Schedule Interval + Bot ScheduleSelect how frequently the bot should run and the days and times it should be active.

Rate TypeChoose whether the bot should submit an All-In rate or a Line Haul rate. Excluding fuel? A Fuel Type option appears.

Spark Intake Form - On-Portal

The On-Portal Spark form with Web-based TMS selected and all input fields completed

A completed On-Portal form: Web-based TMS selected, every input field filled, Submit Spark bottom left.

Three checks that prevent most rejections

Test the credentialsLog in to the TMS yourself first before submitting.

No 2FA on the loginBots can't do 2FA. If required, tell us on your ticket.

Consider a dedicated userA bot-only user avoids single-login conflicts.

All set? Click Submit Spark (bottom left).

Fill the API form

Use this form when requesting an API-based automation. The fields shown will adjust based on the TMS you select. API Direction: choose the direction that matches your integration:

Incoming (HyperY)E2Open-RTR, UberFreight-IRQ, Navisphere / TMC, Emerge, MercuryGate, BlueYonder, WestRock, AVRL-S. For AVRL-S, ticket us first so we can prep the shipper connection.

Outgoing (APIGlue)E2Open-SMA, UberFreight-FAM, Walmart, Trucker Tools, Smart Tendering, and more in the dropdown.

Customer Webhook URLPaste your Teams webhook. If you review load entries through your datastore or Periscope instead, select the database option.

TMS-specific fieldsFields vary by TMS. Some need API credentials issued by the TMS itself - see First-Time TMS API Connection Instructions. Unsure? Ask on your ticket.

Select TMS

The Select TMS dropdown grouped into Web Based, Incoming API Based, and Outgoing API Based

The dropdown groups every option by connection type.

Spark Intake Form - API

An API-based Spark form example with Emerge account fields, quote expiration, rate type, and fuel type

An API form example (Emerge): the fields adapt to the TMS you selected - note the Fuel Type option appearing for a rate that excludes fuel.

TMS not listed, or first API build for your TMS? Ask us on a ticket and we'll send the process checklist. All set? Click Submit Spark (bottom left).

Step 5 of 5

Submit and confirm

Look for the success message

After selecting Submit, wait for the confirmation message before closing the form. Do not submit the same Spark more than once.

Spark Intake Form - submitted

The confirmation you're waiting for - once you see it, you're done.
Save the JSON file

A JSON file will download automatically after submission. Store this file somewhere safe - it contains your completed form responses and can be used to repopulate the form if you ever need to submit it again.

Downloads

Your Spark's JSON lands in your browser downloads automatically - file it somewhere you'll find again.
Your ticket updates itself

Your build ticket will update automatically with the status Spark filled out. No additional action is required until the Spark is processed by AVRL.

What happens next

Your Spark goes to AVRL review. One of two things comes back:

Approved

The approval email means your Spark moves to AVRL Ops, and your ticket notes it. IBG then messages your ticket with a Calendly link and prep for the intake call.

Book it right away - a delayed intake delays your build.

Rejected

The reviewer's note says exactly what went wrong. Open the new link, sign in with Supergen, click Upload Spark to refill the form from your JSON, fix everything flagged, and resubmit.

Approved - example

An approval email confirming the Spark was accepted and sent to the AVRL Ops team

The approval email - your Spark is with AVRL Ops and the intake call is next.

Rejected - example

A rejection email with the reviewer's note and a new Spark Intake Form link

A rejection email - the reviewer's note in quotes tells you exactly what to fix before resubmitting.

Incomplete forms are auto-rejected. Complete every field before submitting.

Keep this page

On-Portal quick referenceAPI quick reference

Spark request, then ticket activates, then email link
Sign in with Supergen
Select Web-based TMS
Webhook URL (or DB checkbox)
TMS URL + tested credentials, no 2FA
Schedules + Rate Type (All-In / line haul)

Spark request (note it's API), then email link
Sign in with Supergen
Exact API type: incoming or outgoing
Webhook URL (or DB checkbox)
TMS-specific fields: some need API creds
First TMS build? Request the checklist

Questions at any step? Ask on your build ticket!