From d47effad24144229a977d2c820d6af85695fc858 Mon Sep 17 00:00:00 2001 From: rohit369-hs <109505886+rohit369-hs@users.noreply.github.com> Date: Wed, 5 Mar 2025 16:36:01 +0530 Subject: [PATCH 01/10] Add User identity bulk APIs --- docs/rest-api/getting-started.mdx | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/rest-api/getting-started.mdx b/docs/rest-api/getting-started.mdx index ed867c3c..3aa9bbf0 100644 --- a/docs/rest-api/getting-started.mdx +++ b/docs/rest-api/getting-started.mdx @@ -134,6 +134,19 @@ List of Endpoints (GET/POST/PUT) | ------- | ------------------------------------------------ | ----------- | | GET | https://api.helpshift.com/v1/ `` /agents | get agents | +### Bulk Actions + +| Command | Request URL | Description | +| ------- | -------------------------------------------------------------------------- | ------------------------------------ | +| POST | https://api.helpshift.com/v1/ `` /bulk_actions/ | create bulk tasks | +| GET | https://api.helpshift.com/v1/ `` /bulk_actions/`{task-id}` | retrive task information | +| GET | https://api.helpshift.com/v1/ `` /bulk_actions/`{task-id}`/errors | retrive task errors (if any) | +| GET | https://api.helpshift.com/v1/ `` /bulk_actions/`{task-id}`/results | retrive task results (if any) | + + +User Idenity Bulk APIs are in Beta Phase, please conatct suppport to know more about it + + ## 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. From 43ab806aaf7af3f2601ca3b169b2b0c8037bcfe3 Mon Sep 17 00:00:00 2001 From: rohit369-hs <109505886+rohit369-hs@users.noreply.github.com> Date: Wed, 5 Mar 2025 16:38:36 +0530 Subject: [PATCH 02/10] Update getting-started.mdx --- docs/rest-api/getting-started.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/rest-api/getting-started.mdx b/docs/rest-api/getting-started.mdx index 3aa9bbf0..189be45b 100644 --- a/docs/rest-api/getting-started.mdx +++ b/docs/rest-api/getting-started.mdx @@ -141,7 +141,7 @@ List of Endpoints (GET/POST/PUT) | POST | https://api.helpshift.com/v1/ `` /bulk_actions/ | create bulk tasks | | GET | https://api.helpshift.com/v1/ `` /bulk_actions/`{task-id}` | retrive task information | | GET | https://api.helpshift.com/v1/ `` /bulk_actions/`{task-id}`/errors | retrive task errors (if any) | -| GET | https://api.helpshift.com/v1/ `` /bulk_actions/`{task-id}`/results | retrive task results (if any) | +| GET | https://api.helpshift.com/v1/ `` /bulk_actions/`{task-id}`/results | retrive task results | User Idenity Bulk APIs are in Beta Phase, please conatct suppport to know more about it From aa2ed714fe8a931b0bf77f86c4e668b7347b4bc4 Mon Sep 17 00:00:00 2001 From: rohit369-hs <109505886+rohit369-hs@users.noreply.github.com> Date: Wed, 5 Mar 2025 16:39:20 +0530 Subject: [PATCH 03/10] Update getting-started.mdx --- docs/rest-api/getting-started.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/rest-api/getting-started.mdx b/docs/rest-api/getting-started.mdx index 189be45b..b1ab559f 100644 --- a/docs/rest-api/getting-started.mdx +++ b/docs/rest-api/getting-started.mdx @@ -134,7 +134,7 @@ List of Endpoints (GET/POST/PUT) | ------- | ------------------------------------------------ | ----------- | | GET | https://api.helpshift.com/v1/ `` /agents | get agents | -### Bulk Actions +### Bulk APIs | Command | Request URL | Description | | ------- | -------------------------------------------------------------------------- | ------------------------------------ | From c203f7653067d57bde000406fac403a7b828b925 Mon Sep 17 00:00:00 2001 From: rohit369-hs <109505886+rohit369-hs@users.noreply.github.com> Date: Wed, 5 Mar 2025 16:41:39 +0530 Subject: [PATCH 04/10] Update getting-started.mdx --- docs/rest-api/getting-started.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/rest-api/getting-started.mdx b/docs/rest-api/getting-started.mdx index b1ab559f..bcaa589c 100644 --- a/docs/rest-api/getting-started.mdx +++ b/docs/rest-api/getting-started.mdx @@ -144,7 +144,7 @@ List of Endpoints (GET/POST/PUT) | GET | https://api.helpshift.com/v1/ `` /bulk_actions/`{task-id}`/results | retrive task results | -User Idenity Bulk APIs are in Beta Phase, please conatct suppport to know more about it +User Idenity Bulk APIs are in Beta Phase, please conatct suppport to know more about it. ## Webhooks From 6365359aa6b0c5e3b1ea75c1a90f47f710bffad7 Mon Sep 17 00:00:00 2001 From: rohit369-hs <109505886+rohit369-hs@users.noreply.github.com> Date: Wed, 5 Mar 2025 16:52:46 +0530 Subject: [PATCH 05/10] Correct spellings --- docs/rest-api/getting-started.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/rest-api/getting-started.mdx b/docs/rest-api/getting-started.mdx index bcaa589c..a4c581ab 100644 --- a/docs/rest-api/getting-started.mdx +++ b/docs/rest-api/getting-started.mdx @@ -144,7 +144,7 @@ List of Endpoints (GET/POST/PUT) | GET | https://api.helpshift.com/v1/ `` /bulk_actions/`{task-id}`/results | retrive task results | -User Idenity Bulk APIs are in Beta Phase, please conatct suppport to know more about it. +User Idenity Bulk APIs are in Beta Phase, please contact support to know more about it. ## Webhooks From 640c951fa270d93c3906c688a8044e1ab7aa8414 Mon Sep 17 00:00:00 2001 From: rohit369-hs <109505886+rohit369-hs@users.noreply.github.com> Date: Thu, 6 Mar 2025 15:00:21 +0530 Subject: [PATCH 06/10] Update getting-started.mdx --- docs/rest-api/getting-started.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/rest-api/getting-started.mdx b/docs/rest-api/getting-started.mdx index a4c581ab..d9a5fa96 100644 --- a/docs/rest-api/getting-started.mdx +++ b/docs/rest-api/getting-started.mdx @@ -139,9 +139,9 @@ List of Endpoints (GET/POST/PUT) | Command | Request URL | Description | | ------- | -------------------------------------------------------------------------- | ------------------------------------ | | POST | https://api.helpshift.com/v1/ `` /bulk_actions/ | create bulk tasks | -| GET | https://api.helpshift.com/v1/ `` /bulk_actions/`{task-id}` | retrive task information | -| GET | https://api.helpshift.com/v1/ `` /bulk_actions/`{task-id}`/errors | retrive task errors (if any) | -| GET | https://api.helpshift.com/v1/ `` /bulk_actions/`{task-id}`/results | retrive task results | +| GET | https://api.helpshift.com/v1/ `` /bulk_actions/`{task-id}` | retrieve task information | +| GET | https://api.helpshift.com/v1/ `` /bulk_actions/`{task-id}`/errors | retrieve task errors (if any) | +| GET | https://api.helpshift.com/v1/ `` /bulk_actions/`{task-id}`/results | retrieve task results | User Idenity Bulk APIs are in Beta Phase, please contact support to know more about it. From 705bf9af03d164f056ef409f8c129ee8b8d26efa Mon Sep 17 00:00:00 2001 From: rohit369-hs <109505886+rohit369-hs@users.noreply.github.com> Date: Thu, 6 Mar 2025 15:03:14 +0530 Subject: [PATCH 07/10] Update getting-started.mdx --- docs/rest-api/getting-started.mdx | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/rest-api/getting-started.mdx b/docs/rest-api/getting-started.mdx index d9a5fa96..018889b5 100644 --- a/docs/rest-api/getting-started.mdx +++ b/docs/rest-api/getting-started.mdx @@ -136,12 +136,12 @@ List of Endpoints (GET/POST/PUT) ### Bulk APIs -| Command | Request URL | Description | -| ------- | -------------------------------------------------------------------------- | ------------------------------------ | -| POST | https://api.helpshift.com/v1/ `` /bulk_actions/ | create bulk tasks | -| GET | https://api.helpshift.com/v1/ `` /bulk_actions/`{task-id}` | retrieve task information | -| GET | https://api.helpshift.com/v1/ `` /bulk_actions/`{task-id}`/errors | retrieve task errors (if any) | -| GET | https://api.helpshift.com/v1/ `` /bulk_actions/`{task-id}`/results | retrieve task results | +| Command | Request URL | Description | +| ------- | ----------------------------------------------------------------------------------- | ------------------------------ | +| POST | https://api.helpshift.com/v1/ `` /identity/bulk_actions/ | create bulk tasks | +| GET | https://api.helpshift.com/v1/ `` /identity/bulk_actions/`{task-id}` | retrieve task information | +| GET | https://api.helpshift.com/v1/ `` /identity/bulk_actions/`{task-id}`/errors | retrieve task errors (if any) | +| GET | https://api.helpshift.com/v1/ `` /identity/bulk_actions/`{task-id}`/results | retrieve task results | User Idenity Bulk APIs are in Beta Phase, please contact support to know more about it. From 120bd4c1b47ab23c9f6ef4b2cb248c69128e10e4 Mon Sep 17 00:00:00 2001 From: rohit369-hs <109505886+rohit369-hs@users.noreply.github.com> Date: Thu, 6 Mar 2025 16:12:37 +0530 Subject: [PATCH 08/10] PM feedback --- docs/rest-api/getting-started.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/rest-api/getting-started.mdx b/docs/rest-api/getting-started.mdx index 018889b5..3771a2f8 100644 --- a/docs/rest-api/getting-started.mdx +++ b/docs/rest-api/getting-started.mdx @@ -134,17 +134,17 @@ List of Endpoints (GET/POST/PUT) | ------- | ------------------------------------------------ | ----------- | | GET | https://api.helpshift.com/v1/ `` /agents | get agents | -### Bulk APIs +### User Hub Bulk APIs | Command | Request URL | Description | -| ------- | ----------------------------------------------------------------------------------- | ------------------------------ | +| ------- | ------------------------------------------------------------------------------------ | ------------------------------ | | POST | https://api.helpshift.com/v1/ `` /identity/bulk_actions/ | create bulk tasks | | GET | https://api.helpshift.com/v1/ `` /identity/bulk_actions/`{task-id}` | retrieve task information | | GET | https://api.helpshift.com/v1/ `` /identity/bulk_actions/`{task-id}`/errors | retrieve task errors (if any) | | GET | https://api.helpshift.com/v1/ `` /identity/bulk_actions/`{task-id}`/results | retrieve task results | -User Idenity Bulk APIs are in Beta Phase, please contact support to know more about it. +User Hub Bulk APIs are in Beta Phase, please customer success to know more about it. ## Webhooks From 854c97f68a19025741d4bc411401290d2e4ec630 Mon Sep 17 00:00:00 2001 From: rohit369-hs <109505886+rohit369-hs@users.noreply.github.com> Date: Thu, 6 Mar 2025 16:15:00 +0530 Subject: [PATCH 09/10] Typo for contact --- docs/rest-api/getting-started.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/rest-api/getting-started.mdx b/docs/rest-api/getting-started.mdx index 3771a2f8..d76c5396 100644 --- a/docs/rest-api/getting-started.mdx +++ b/docs/rest-api/getting-started.mdx @@ -144,7 +144,7 @@ List of Endpoints (GET/POST/PUT) | GET | https://api.helpshift.com/v1/ `` /identity/bulk_actions/`{task-id}`/results | retrieve task results | -User Hub Bulk APIs are in Beta Phase, please customer success to know more about it. +User Hub Bulk APIs are in Beta Phase, please contact customer success to know more about it. ## Webhooks From bf56bbb18695c49f2adfb850a00b31bae0615b5f Mon Sep 17 00:00:00 2001 From: rohit369-hs <109505886+rohit369-hs@users.noreply.github.com> Date: Wed, 12 Mar 2025 12:35:01 +0530 Subject: [PATCH 10/10] Change version to v2 for user hub apis --- docs/rest-api/getting-started.mdx | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/rest-api/getting-started.mdx b/docs/rest-api/getting-started.mdx index d76c5396..7c040e00 100644 --- a/docs/rest-api/getting-started.mdx +++ b/docs/rest-api/getting-started.mdx @@ -138,10 +138,10 @@ List of Endpoints (GET/POST/PUT) | Command | Request URL | Description | | ------- | ------------------------------------------------------------------------------------ | ------------------------------ | -| POST | https://api.helpshift.com/v1/ `` /identity/bulk_actions/ | create bulk tasks | -| GET | https://api.helpshift.com/v1/ `` /identity/bulk_actions/`{task-id}` | retrieve task information | -| GET | https://api.helpshift.com/v1/ `` /identity/bulk_actions/`{task-id}`/errors | retrieve task errors (if any) | -| GET | https://api.helpshift.com/v1/ `` /identity/bulk_actions/`{task-id}`/results | retrieve task results | +| POST | https://api.helpshift.com/v2/ `` /identity/bulk_actions/ | create bulk tasks | +| GET | https://api.helpshift.com/v2/ `` /identity/bulk_actions/`{task-id}` | retrieve task information | +| GET | https://api.helpshift.com/v2/ `` /identity/bulk_actions/`{task-id}`/errors | retrieve task errors (if any) | +| GET | https://api.helpshift.com/v2/ `` /identity/bulk_actions/`{task-id}`/results | retrieve task results | User Hub Bulk APIs are in Beta Phase, please contact customer success to know more about it.