PipedreamHQ / PipedreamHQ/pipedream
[ACTION] Freshchat - Retrieve user information (get user by user_id)
- Dominant language
- JavaScript
- Stars
- 11.7k
- Forks
- 5.8k
- Avg merge
- 3d 10h
- Merged PRs (30d)
- 102
Description
(For Neople)
**Is there a specific app this action is for?**
Freshchat
**Please provide a link to the relevant API docs for the specific service / operation.**
https://developers.freshchat.com/api/#retrieve_user_information
`GET /v2/users/{user_id}`
--> Retrieve a single user by `user_id` so we can resolve the customer's name and email for a conversation.
**Why**
The existing Freshchat actions never return customer details. `freshchat-fetch-conversation-details` returns only `user_id` (a UUID), and `freshchat-list-messages` returns only `actor_id` / `user_id`. The webhook payload likewise carries just `actor.actor_id`. So there is currently no way to get the name or email of the person in a chat, which every other helpdesk integration exposes.
**Props**
- `userId` (string, required) — the user UUID, as returned in `conversation.user_id` or `message.actor_id`
**Response fields we need**
`first_name`, `last_name`, `email`, `phone`, `properties`, plus whatever else the endpoint returns (`id`, `created_time`, `updated_time`, `avatar`, `login_status`, `org_contact_id`, `reference_id`, `restore_id`, `social_profiles`).
Contributor guide
Research direction
Start by examining the existing Freshchat actions named in the issue, especially freshchat-fetch-conversation-details and freshchat-list-messages, and compare their API request and response handling with the linked GET /v2/users/{user_id} documentation. Add the userId input and expose the requested user fields, then verify the action returns the Freshchat user information.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- api
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100