From 123718029d99d1a17e42a3c2855a822823f8332c Mon Sep 17 00:00:00 2001 From: George Champlin-Scharff Date: Thu, 18 Feb 2021 16:02:25 -0500 Subject: [PATCH 01/10] Update README.md Add info about the workspace_id to the Notes section, a user booked a support session to find this info out. --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index dc5198c..958e6b2 100644 --- a/README.md +++ b/README.md @@ -112,6 +112,7 @@ The ZenHub API can return the following errors: #### Notes - `repo_id` is the ID of the repository, not its full name. For example, the ID of the `ZenHubIO/API` repository is `47655910`. To find out the ID of your repository, use [GitHub’s API](https://developer.github.com/v3/repos/#get), or copy it from the URL of the Board (for this repo, the Board URL is https://github.com/ZenHubIO/API#boards?repos=47655910). +- `workspace_id` is the ID of the ZenHub Workspace. This is found in the URL for the Workspace after the name of the workspace. For example, the `workspace_id` for `https://app.zenhub.com/workspaces/workflows---product--design-workspace-5f6b5c9ab4fd7d76a3e5b7d8/board?` is `5f6b5c9ab4fd7d76a3e5b7d8`. ## Issues From 58cc06510bdf99cf881f3572a6f093330eda1230 Mon Sep 17 00:00:00 2001 From: Cameron Warje Date: Mon, 12 Apr 2021 16:56:27 -0400 Subject: [PATCH 02/10] Adding instructions for ZHE3 --- README.md | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 958e6b2..0d22169 100644 --- a/README.md +++ b/README.md @@ -58,12 +58,24 @@ You can also submit a feature request [here](https://portal.productboard.com/zen ## Root Endpoint -On Cloud, the root endpoint for the public API is `https://api.zenhub.com/`. -For ZenHub Enterprise, the root endpoint is `https:///`. +The ZenHub API root endpoint for Cloud is different than that of Enterprise and has also changed across Enterprise versions. Please refer to the table below for the appropriate endpoint. + +ZenHub Version | API Root Endpoint +--- | --- +Cloud | `https://api.zenhub.com/` +Enterprise 2 | `https:///` +Enterprise 3 | `https:///api/` ## Authentication -All requests to the API need an API token. Generate a token in the **API Tokens** section of your ZenHub [Dashboard](https://app.zenhub.com/dashboard/tokens) (or `https:///app/dashboard/tokens` for ZenHub Enterprise). The token is sent in the `X-Authentication-Token` header. For example, using `curl` it’d be: +All requests to the API need an API token. Generate a token in the **API Tokens** section of your ZenHub [Dashboard](https://app.zenhub.com/dashboard/tokens) (for ZenHub Enterprise, refer to the table below for the proper link). + +ZenHub Enterprise Version | Auth Token Generation Page +--- | --- +Enterprise 2 | `https:///app/dashboard/tokens` +Enterprise 3 | `https:///dashboard/tokens` + +The token is sent in the `X-Authentication-Token` header. For example, using `curl` it would be: ```sh curl -H 'X-Authentication-Token: TOKEN' URL From e5cabdbaca42345643be7447b5ee9fed44efdb6c Mon Sep 17 00:00:00 2001 From: Cameron Warje Date: Mon, 12 Apr 2021 16:58:25 -0400 Subject: [PATCH 03/10] Removing reference to deprecated instruction page --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 0d22169..611debc 100644 --- a/README.md +++ b/README.md @@ -86,7 +86,6 @@ Alternatively, you can choose to send the token in the URL using the `access_tok #### Notes - Each user may only have one token, so generating a new token will invalidate previously created tokens. -- For ZenHub Enterprise users, please follow the instructions in `https:///setup/howto/api` ## Content-Type: JSON From 50f290b527758229c4f60c6015a731df40548b91 Mon Sep 17 00:00:00 2001 From: Cameron Warje Date: Mon, 12 Apr 2021 17:26:43 -0400 Subject: [PATCH 04/10] Update README.md Clarifying wording. Co-authored-by: Ev Haus --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 611debc..17363d9 100644 --- a/README.md +++ b/README.md @@ -58,7 +58,7 @@ You can also submit a feature request [here](https://portal.productboard.com/zen ## Root Endpoint -The ZenHub API root endpoint for Cloud is different than that of Enterprise and has also changed across Enterprise versions. Please refer to the table below for the appropriate endpoint. +The ZenHub API root endpoint for Cloud is different than that of ZenHub On-Premise Enterprise instances and has also changed across Enterprise versions. Please refer to the table below for the appropriate endpoint. ZenHub Version | API Root Endpoint --- | --- From 42c771c1f63fc1c536d528001f06dcb0582a4afb Mon Sep 17 00:00:00 2001 From: Cameron Warje Date: Wed, 9 Jun 2021 16:14:17 -0400 Subject: [PATCH 05/10] Update API Documentation README --- README.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 17363d9..d6b6bb1 100644 --- a/README.md +++ b/README.md @@ -53,6 +53,7 @@ You can also submit a feature request [here](https://portal.productboard.com/zen [Webhooks](#webhooks) - [Custom Webhooks](#custom-webhooks) + - [Content Type: urlencoded](#content-type-urlencoded) [Contact Us](#contact-us) @@ -1348,7 +1349,14 @@ For instructions, you'll notice the `How to create a webhook` link changes dynam ### Custom webhooks -Our custom webhook sends a POST request to your webhook for multiple events that occur on your ZenHub board: +Our custom webhook sends a POST request to your webhook for multiple events that occur on your ZenHub board. See below for examples of the events and data that they will contain. Please note that the content type in the examples has been written in JSON, however the actual data is sent in **x-www-form-urlencoded** format. + +#### Content Type: urlencoded + +The POST request is sent in the **x-www-form-urlencoded** format. + +Example: +```field1=value1&field2=value2``` #### Issue transfer @@ -1362,6 +1370,8 @@ Our custom webhook sends a POST request to your webhook for multiple events that "issue_number": "618", "issue_title": "ZenHub Change Log", "to_pipeline_name": "New Issues", + "workspace_id": "603fc3e575de63001cc163f9", + "workspace_name" "My Workspace", "from_pipeline_name": "Discussion" } ``` @@ -1408,7 +1418,9 @@ Our custom webhook sends a POST request to your webhook for multiple events that "issue_title": "ZenHub Change Log", "to_pipeline_name": "Backlog", "from_position": "4", - "to_position": "0" + "to_position": "0", + "workspace_id": "603fc3e575de63001cc163f9", + "workspace_name" "My Workspace" } ``` From 9751fb71631ece463cd1601ef54b39e4ba234687 Mon Sep 17 00:00:00 2001 From: Cameron Warje Date: Wed, 9 Jun 2021 16:25:27 -0400 Subject: [PATCH 06/10] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d6b6bb1..a84bac0 100644 --- a/README.md +++ b/README.md @@ -1371,7 +1371,7 @@ Example: "issue_title": "ZenHub Change Log", "to_pipeline_name": "New Issues", "workspace_id": "603fc3e575de63001cc163f9", - "workspace_name" "My Workspace", + "workspace_name": "My Workspace", "from_pipeline_name": "Discussion" } ``` From cce1e8f3532b437739a7413c2a48197ca7a74cc8 Mon Sep 17 00:00:00 2001 From: Joseph Totera Date: Wed, 15 Jun 2022 09:36:49 -0400 Subject: [PATCH 07/10] - Update readme - Added maintenance and support section to readme informing users this api is no longer maintained --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index a84bac0..1b488f8 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,7 @@ +# ⚠️ Maintenance +This API is no longer actively maintained and has a limited feature set. Please take a look at our updated API and documentation available at https://developers.zenhub.com + + # Getting support If you have any questions or feedback, **contact [support](mailto:support@zenhub.com) for support**. The ZenHub Board for this repo has been sunset - all support inquiries should be submitted directly through the email above. From 2c820ede48f8bea7766e718fb76607163081f2ab Mon Sep 17 00:00:00 2001 From: Ev Haus Date: Thu, 15 Feb 2024 08:21:37 -0800 Subject: [PATCH 08/10] Update README.md --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1b488f8..b102caa 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ -# ⚠️ Maintenance -This API is no longer actively maintained and has a limited feature set. Please take a look at our updated API and documentation available at https://developers.zenhub.com +# ⚠️ Deprecation Notice +> [!WARNING] +> This API has not been updated since 2021 is scheduled for deprecation. Please use our new GraphQL API at https://developers.zenhub.com # Getting support From b751859e151ceba383151fe5f8c288bc949c488e Mon Sep 17 00:00:00 2001 From: Ev Haus Date: Thu, 15 Feb 2024 08:24:52 -0800 Subject: [PATCH 09/10] Update README.md --- README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/README.md b/README.md index b102caa..18666b8 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,7 @@ # Getting support -If you have any questions or feedback, **contact [support](mailto:support@zenhub.com) for support**. The ZenHub Board for this repo has been sunset - all support inquiries should be submitted directly through the email above. - -You can also submit a feature request [here](https://portal.productboard.com/zenhub). +If you have any questions or feedback, **contact [support](mailto:support@zenhub.com)**. You can submit feature requests [here](https://portal.productboard.com/zenhub). # Overview From d48e46813953bccaf6b6ff3a97f6697835fbeff7 Mon Sep 17 00:00:00 2001 From: Ev Haus Date: Wed, 28 May 2025 16:30:35 -0700 Subject: [PATCH 10/10] Update README.md --- README.md | 6 ------ 1 file changed, 6 deletions(-) diff --git a/README.md b/README.md index 18666b8..f8e5466 100644 --- a/README.md +++ b/README.md @@ -159,11 +159,6 @@ Get the data for a specific issue. "estimate": { "value": 8 }, - "plus_ones": [ - { - "created_at": "2015-12-11T18:43:22.296Z" - } - ], "pipeline": { "name": "QA", "pipeline_id": "5d0a7a9741fd098f6b7f58a7", @@ -187,7 +182,6 @@ Get the data for a specific issue. #### Notes -- `plus_ones[].user_id` was removed from the response. - `pipeline` object references the oldest Workspace pipeline this issue is in. - **NOTE:** If an issue's status is closed, the `pipeline` value will describe the Pipeline that the issue was in prior to the issue being closed. The ZenHub API does not consider the "Closed" Pipeline to be a distinct Pipeline at this time and you should **not** use the Pipeline value to determine whether or not an issue is closed or open (use `status` instead). - **NOTE:** Reopened issues might take up to one minute to show up in the correct Pipeline.