Skip to content

Add User identity bulk APIs #163

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

Open
rohit369-hs wants to merge 10 commits into
base: main
Choose a base branch
from
Open

Add User identity bulk APIs #163

Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
d47effa
Add User identity bulk APIs
rohit369-hs Mar 5, 2025
43ab806
Update getting-started.mdx
rohit369-hs Mar 5, 2025
aa2ed71
Update getting-started.mdx
rohit369-hs Mar 5, 2025
c203f76
Update getting-started.mdx
rohit369-hs Mar 5, 2025
6365359
Correct spellings
rohit369-hs Mar 5, 2025
640c951
Update getting-started.mdx
rohit369-hs Mar 6, 2025
705bf9a
Update getting-started.mdx
rohit369-hs Mar 6, 2025
120bd4c
PM feedback
rohit369-hs Mar 6, 2025
854c97f
Typo for contact
rohit369-hs Mar 6, 2025
bf56bbb
Change version to v2 for user hub apis
rohit369-hs Mar 12, 2025
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
13 changes: 13 additions & 0 deletions docs/rest-api/getting-started.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,19 @@ List of Endpoints (GET/POST/PUT)
| ------- | ------------------------------------------------ | ----------- |
| GET | https://api.helpshift.com/v1/ `<domain>` /agents | get agents |

### User Hub Bulk APIs

| Command | Request URL | Description |
| ------- | ------------------------------------------------------------------------------------ | ------------------------------ |
| POST | https://api.helpshift.com/v2/ `<domain>` /identity/bulk_actions/ | create bulk tasks |
| GET | https://api.helpshift.com/v2/ `<domain>` /identity/bulk_actions/`{task-id}` | retrieve task information |
| GET | https://api.helpshift.com/v2/ `<domain>` /identity/bulk_actions/`{task-id}`/errors | retrieve task errors (if any) |
| GET | https://api.helpshift.com/v2/ `<domain>` /identity/bulk_actions/`{task-id}`/results | retrieve task results |

<Admonition type="info" title="Note">
User Hub Bulk APIs are in Beta Phase, please contact customer success to know more about it.
</Admonition>

## Webhooks

Helpshift Webhooks allow you to set up an integration with a third party service, such as Slack, PowerBI, a bot engine, and others, based on Helpshift events.
Expand Down