Route4Me Callback Settings – Setting Up Activity Feed Webhooks on Your Route4Me Web Account (Callback URL)

Real-time callbacks permit third-party systems to receive notifications about every Route4Me system and driver event, such as when a user manually generates a notification or when the system automatically logs a driver entering a dynamic geofence, marking address as Visited, adding a note, and more. The callback is set at the Account Owner user level, so all activities detected by sub-users and sub-drivers are also sent to the defined callback URL. Moreover, you can receive notifications to the defined callback URL triggered by the events that are logged from the Route4Me Web Platform, as well as Route4Me’s iOS and Android mobile apps.

 

To set up or edit your Route4Me account Activity Feed callback settings, first, go to “Account Settings” from the navigation menu and then scroll to the “Activity Feed Settings” section.

Route4Me Webhooks - Setting Up Activity Feed Callbacks on Your Route4Me Web Account

 

In the “Activity Feed Settings” section, you can add a new or update the existing webhook for your Route4Me Activity Feed. To do so, insert the URL which you want to use for receiving notifications into the “Callback URL” field and then select the preferred callback method. To use the “POST” callback method, select the corresponding option from the list.

Route4Me Webhooks - Setting Up Activity Feed Callbacks on Your Route4Me Web Account

 

Once selected, whenever you or one of the users associated with the Primary Route4Me Account trigger a particular notification, the corresponding “POST” notification will be automatically sent to the defined webhook link. For example, when you or one of your sub-users mark a particular stop as “Visited” (from the Route4Me Web Platform or Route4Me’s iOS and Android mobile apps), the corresponding notification will be automatically sent to the defined webhook link with the event’s details (i.e., timestamp(s), activity ID, your Route4Me account API key, etc.).

Route4Me Webhooks - Setting Up Activity Feed Callbacks on Your Route4Me Web Account

 

To use the “PUT” callback method, select the corresponding option from the list.

Route4Me Webhooks - Setting Up Activity Feed Callbacks on Your Route4Me Web Account

 

Once selected, whenever you or one of the users associated with the Primary Route4Me Account trigger a particular notification, the corresponding “PUT” notification will be automatically sent to the defined webhook link. For example, when you or one of your sub-users add a note to a route stop (from the Route4Me Web Platform or Route4Me’s iOS and Android mobile apps), the corresponding notification will be automatically sent to the defined webhook link with the event’s details (i.e., activity message, device type, your Route4Me account API key, etc.).

Route4Me Webhooks - Setting Up Activity Feed Callbacks on Your Route4Me Web Account

 

To use the “GET” callback method, select the corresponding option from the list.

Route4Me Webhooks - Setting Up Activity Feed Callbacks on Your Route4Me Web Account

 

Callback Notifications Triggers

All activities/events that are recorded and stored in your Route4Me Activity Feed can trigger notifications that are sent to the defined callback URL. The table below provides the list of the activities/events that can trigger sending notifications to the defined callback URL.

Route4Me Webhooks Settings - Setting Up Activity Feed Callbacks on Your Route4Me Web Account

Trigger/Activity/EventDescription
Geofence Triggered Check InUser entered the geofence set around the given route destination (learn more).
Geofence Triggered Check OutUser left the geofence set around the given route destination.
User MessageUser sent or received the given message in the live chat (learn more).
Approved to ExecuteThe route was dispatched/Approved to Execute (learn more).
Remove Address from RouteAddress was removed/deleted from the corresponding route.
Add New AddressAddress was added/inserted into the corresponding route.
Mark Address VisitedAddress was marked as “Visited” from the Route4Me Web Platform or Route4Me’s iOS and Android mobile apps.
Mark Address DepartedAddress was marked as “Departed” from the Route4Me Web Platform or Route4Me’s iOS and Android mobile apps.
Change Address SequenceAddress changed its sequence position within the corresponding route (learn more).
Update Address AttributeThe details of the corresponding address were updated/changed.
Created Team MemberNew user was created (learn more).
Delete Team MemberExisting user was deleted (learn more).
Modified MemberThe details of an existing user were edited/updated (learn more).
Note InsertNote was added to the corresponding route stop (learn more).
Delete RouteRoute was deleted.
Route OptimizedRoute was re-optimized (learn more).
Assigned Other User to RouteAnother user was assigned to the given route / the owner of the route was changed (learn more).
Route MergingSeveral routes were merged to create a new route (learn more).
Route DuplicationRoute was duplicated (learn more).
User Arrived EarlyUser arrived 1 hour earlier than the estimated arrival time (ETA).
User Arrived on TimeUser arrived within the 1-hour range of the estimated arrival time (ETA).
User Arrived LateUser arrived 1 hour later than the estimated arrival time (ETA).

 

Was this article helpful?
Still can't find what you're looking for? Contact us