Retail Zipline
SYNQ supports Retail Zipline as a communication platform provider. This means that all staff-facing notifications generated by SYNQ will be delivered to configurable Zipline teams as Tasks.
To configure SYNQ to use Retail Zipline for your store location you need to:
- Install the Retail Zipline app on your devices.
- Determine the Retail Zipline teams that represent groups of workers that should receive notifications.
- Configure SYNQ to be aware of your Retail Zipline instance and teams.
- Configure SYNQ apps and devices to send their notifications to your Retail Zipline teams.
Once configured, SYNQ Frontline Hero delivers customer requests from call buttons and QRs to your staff as Tasks in Retail Zipline.
Supported Modules
Retail Zipline is supported for the following SYNQ modules:
- Call for Help
Requirements
The following information is required to integrate Retail Zipline with SYNQ Frontline Hero:
- Retail Zipline API client credentials.
- Retail Zipline webhooks that deliver task updates back to SYNQ Frontline Hero.
- Retail Zipline Team IDs that represent the Retail Zipline user groups that should receive notifications.
Configuration
To provide Frontline Hero with the Retail Zipline API client credentials:
- Sign into MyStore as a Location Administrator.
- Select Configure Store.
- Scroll down to Bot configuration + Channels.
- Set Notification Method to
Zipline Bot. - Provide the following:
- Zipline Client ID
- Zipline Client Secret
- Zipline Subdomain
- Zipline Username
- Zipline Password
- Copy the Webhook URL from the information box.
- Configure Webhooks in Retail Zipline:
- Sign in to the Retail Zipline portal.
- Click on your user avatar and select Settings.
- Click Webhooks.
- Click Add Webhook.
- Provide a Name. For example,
SYNQ Frontline Hero. - Paste the copied Webhook URL.
- Click Add Webhook.
- Copy the Secret.
- To add an event subscription:
- Click Add Event Subscription.
- Select the desired event.
- Click Add Event.
- Add event subscriptions for the following events:
Task assignedTask unassignedTeam task assignedTeam task cancelledTeam task completedTeam task createdTeam task deletedTeam task uncompleted
- Click Enable Webhook.
- Return to MyStore.
- Paste the copied secret into Zipline Webhook Secret.
- Click Update Location Settings.
To define a target Retail Zipline group that should receive Frontline Hero notifications:
- Click the Add Bot Instance button.
- Provide the following:
- Name: A display name for this group of users. This is how the group will appear elsewhere in MyStore when you are selecting which group will receive notifications.
- ID: The ID of the Retail Zipline team that will receive notifications.
- Click Save.
- Repeat to add other groups.