Enabling the Turvo TMS requires the following process:
Create an API User and obtain an API Key in Turvo
Enable the Turvo App in Chain, and copy the token that is generated
Create Webhooks inside of Turvo
Note: Only Super Admins in Turvo can perform these steps
Step 1: Create an API User
Only super admins can do this. Go to the
Admin Console
Under
User management
, selectUsers
Create a user with Admin permissions, you can name it Chain API User. Make sure you have access to this email, as you will need to set the password from the email you get.
You will receive a Turvo welcome email for this user to set the password. Go ahead and set a password and make sure to note down the password. You will need it in a later step.
Then go back to the
Admin console
Under
Data & integrations
selectAPI & Webhooks
In the
API & Webhooks
page, at the bottom, select+ Add public API profile
(note, only Super Admins will see this button)
Put “Chain” for the
API profile name
. Then search for the user you created. It should show like this:
Select the User, and click
Save
Note down the
Client name
andClient secret
Next, at the top, check to see if you have an API Key. If you do, note it down, it will be used in Chain’s Turvo App. If not, create one and note it down:
Step 2: Enable the Turvo App in Chain
Go to Chain,
Settings
>Apps
Find the Turvo App and click Enable
Add the Client name, Client secret, API Key and User name (email) and the password you set in Step 1. And Click Enable.
If all details are correct, you will get a
Token
that is generated for you.Note this value down as it will be used for 3 webhooks we created in Step 3, and it will be the same for all three webhooks (Shipment, Carrier, User)
Step 3: Create Webhooks in Turvo
Again, as a Super Admin, click your Avatar in Turvo >
Admin Console
>API & Webhooks
> then select theWebhooks
tabAt the bottom, you will see
+ Add Webhook profile
(Only Super Admins will see this button)
We will be creating 3 webhooks:
Shipment
,Carrier
, andUser
Create Shipment webhook
Profile Name:
Chain Shipment Webhook
Notify URL
Production URL:
https://api.chaineapp.com/apps/events/v1/turvo
Staging URL
https://api.staging.chaineapp.com/apps/events/v1/turvo
Auth type:
Permanent token
Token: Copy paste this value from Step 2 from the Turvo App in Chain.
Check the boxes under Shipment
Create
,Update
,Delete
, andStatus
Create Carrier webhook
Profile Name:
Chain Carrier Webhook
Notify URL:
Production URL:
https://api.chaineapp.com/apps/events/v1/turvo/carriers
Staging URL
https://api.staging.chaineapp.com/apps/events/v1/turvo/carriers
Auth type:
Permanent token
Token: Copy paste this value from Step 2 from the Turvo App in Chain.
Check the boxes under Carrier
Create
,Update
,Delete
, andStatus
Create User webhook
Profile Name:
Chain User Webhook
Notify URL:
Production URL:
https://api.chaineapp.com/apps/events/v1/turvo/users
Staging URL
https://api.staging.chaineapp.com/apps/events/v1/turvo/users
Auth type:
Permanent token
Token: Copy paste this value from Step 2 from the Turvo App in Chain.
Check the boxes under
Create
,Update
, andDelete
In the end, you should have 3 webhooks created with a status of
Active
:
If you've done everything right, you will start to see loads populate in Chain whenever there is a change on a load in Turvo.