Skip to content

Updates to Workramp Source docs #3192

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 8, 2022
Merged

Updates to Workramp Source docs #3192

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 19 additions & 24 deletions src/connections/sources/catalog/cloud-apps/workramp/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This is an [Event Cloud Source](https://segment.com/docs/sources/#event-cloud-so
This source is maintained by WorkRamp. For any issues with the source, [contact the WorkRamp support team](mailto:support@workramp.com).

> info "The WorkRamp source is in Beta"
> WorkRamp are actively developing the source. This doc was last updated on June 2, 2022. If you are interested in joining their beta program or have any feedback to help improve the WorkRamp Source and its documentation, contact [support@workramp.com](mailto:support@workramp.com)
> WorkRamp are actively developing the source. This doc was last updated on July 8, 2022. If you are interested in joining their beta program or have any feedback to help improve the WorkRamp Source and its documentation, contact [support@workramp.com](mailto:support@workramp.com)



Expand All @@ -33,30 +33,26 @@ The table below lists events tracking user interaction in WorkRamp Academy. Wor

| Event Name | Description |
| --------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Registers | The user registers for academy. All custom registration fields appear under user unless they are marked as “hidden” or a password. |
| Signed In | The user logs into academy. |
| Signed Out | The user clicks **Logout** from the User menu. |
| User Registered | The user registers for the academy. All custom registration fields appear under user unless they are marked as “hidden” or a password. |
| User Login | The user logs into the academy. |
| User Logout | The user clicks **Logout** from the User menu. |
| Search | The user types a query into the Search bar. |
| Search Result Clicked | The user clicks on a search result from the Search bar. |
| Starts Training | The user clicks **Get Started** from `/training/:training_id/overview/`. |
| Enters Path Training | The user clicks **Get Started** or **Continue** from `/paths/:path_id`. |
| Enters Certification Training | The user clicks **Get Started** or **Continue** from `/certifications/:certification_id`. |
| Resumes Training | The user clicks **Continue** from `/training/:training_id/overview`. |
| Reviews Training | The user clicks on search result from the Search bar. |
| Checkout Initiated | The user clicks **Purchase Guide: [Price]** from `/training/:training_id/overview/`. |
| Task Viewed | The user visits `/guides/:guide_id/tasks/:task_id/`. |
| Completes Training | The user clicks **Finish** in a Course. Similar to **Exits Course**, this event populates the fields of `certificationId/pathId` depending on the content type. |
| Completes Path | The user clicks **Finish** within a Course. Similar to **Exits Course**, this event populates the fields of `certificationId/pathId` depending on the content type. |
| Completes Certification | The user clicks **Finish** within a Certification Course. Similar to **Exits Course**, this event populates the fields of `certificationId/pathId` depending on the content type. |
| Content Started | The user clicks **Get Started** from a course page |
| Content Resumed | The user clicks **Continue** from a course page. |
| Task Viewed | User views a task within Content. |
| Task Completed | User clicks “Next” from Task Viewed. |
| Content Completed | The user clicks **Finish** in a Course, Path or Certification. Properties will be including certificationId/pathId will be dependent on the content type |
| Content Reviewed | User clicks “Review” from course page to re-enter previously completed content. |
| Enters Training: Path | The user clicks **Get Started** or **Continue** from `/paths/:path_id`. |
| Enters Training: Certification | The user clicks **Get Started** or **Continue** from `/certifications/:certification_id`. |
| Copies Public Link to Certification | The user clicks **Copy Public Link** on `/certifications/:certification_id`. |
| Clicks “Adds Certification to LinkedIn” | The user clicks **Add to LinkedIn** on `/certifications/:certification_id/`. |
| Downloads Certification | The user clicks **Download** on `/certifications/:certification_id/`. |
| Exits Course | The user clicks the back arrow within a Training. If the course is part of path or certification, the associated fields will populate. |
| Downloads Certification | The user clicks **Download** on `/certifications/:certification_id/`. |
| Views Content | The user clicks **Show Content**. |
| Hides Content | The user clicks **Hide Content**. |
| Views Event | The user visits `/events/:event_id`. |
| Clicks Session URL | The user clicks **Register Now** (the session URL) from the events page. |

| Event Viewed | The user visits `/events/:event_id`. |
| Register Now for Event Session | The user clicks **Register Now** (the session URL) from the events page. |



Expand All @@ -68,12 +64,11 @@ The table below list the properties included in the events listed above.
| Property Name | Description |
| -------------------------------------------------- | --------------------------------------------------------------------- |
| `academyTitle` | Name of the Academy. |
| `timeStamp` | Time captured for the event, for example, '2022-05-25T21:29:53.429Z'. |
| `timeStamp`, `receivedAt` | Time captured for the event, for example, '2022-05-25T21:29:53.429Z'. |
| `accessedDate` | Timestamp for when the content was started by user. |
| `id` | The user’s ID. |
| `email_subject` | Subject line of the email. |
| `email` | The user’s Email Address. |
| `name` | The user’s Name. |
| `userId` | The user’s ID. |
| `user.email` | The user’s Email Address. |
| `user.name` | The user’s Name. |
| Custom registration fields `department`, `title`) | URL of the link clicked. |
| `searchTerm` | Query entered in search bar. |
| `contentId` | ID for the content (for example, guide ID). |
Expand Down