zeebe api tutorial #4058
zeebe api tutorial #4058
Conversation
christinaausley
added
component:zeebe
|
👋 🤖 ✅ Looks like the changes were ported across versions, nice job! 🎉 You can read more about the versioning within our docs in our documentation guidelines. |
Co-authored-by: Steven Hicks <[email protected]>
Co-authored-by: Steven Hicks <[email protected]>
|
This is ready for final review 🥳 |
|
|
||
| ::: | ||
|
|
||
| ## Assign a Zeebe user task (POST) |
There was a problem hiding this comment.
💡 Since Zeebe user tasks are a bit of a new concept, it might be worth mentioning briefly in this tutorial that task assignment happened in Tasklist previously. We don't have to add this now, but it might be something to get broader feedback on.
There was a problem hiding this comment.
In addition, I think we should call out that they can capture a Zeebe user task ID, which they will use to assign/unassign in this API, from Tasklist....but it has to be a Zeebe task, not a legacy task.
We could link them to this doc, which describes the difference between zeebe user tasks & legacy user tasks. It's an important distinction that I personally overlooked, and I think it's likely that readers will do the same.
There was a problem hiding this comment.
Adjusted in latest commit 👍
| } | ||
| ``` | ||
|
|
||
| 8. In your terminal, run `node cli.js zeebe assign <task id> <[email protected]>`, where `<task id>` is the Zeebe user task ID, and `<[email protected]>` is the assignee's email address. |
There was a problem hiding this comment.
💡 You could consider having the user assign their own email address if they want to see it in the UIs.
There was a problem hiding this comment.
🗒️ if you were wondering, like me, what would happen if one assigned a task via the API to a user not in their organization, the answer is:
It will work just fine.
There was a problem hiding this comment.
Also, I don't have a specific suggestion, but this might also be a good place to specify where they got a Zeebe user task ID from. ("The ID you've captured from Tasklist" or something like that)
There was a problem hiding this comment.
Adjusted in latest commit 👍
| This `assign` command is connected to the `assignUser` function at the bottom of the `zeebe.js` file, and executed by the `cli.js` file. While we will assign and unassign users in this tutorial, you may add additional arguments depending on the API calls you would like to make. | ||
| ::: | ||
|
|
||
| If you have a valid user and task ID, the assignment will now output. If you have an invalid API name or action name, or no arguments provided, or improper/insufficient credentials configured, an error message will output as outlined in the `cli.js` file. |
There was a problem hiding this comment.
Non-blocking feedback: I was surprised that the action wasn't required in the API reference docs.
A custom action value that will be accessible from user task events resulting from this endpoint invocation. If not provided, it will default to "assign".
I did see that this is consistent (if no action is provided, it will default) everywhere except when unassigning a user. I'll let you decide if you want to call this out and how you want to note it. Alternatively, you can wait for feedback on this.
|
|
||
| ::: | ||
|
|
||
| ## Assign a Zeebe user task (POST) |
There was a problem hiding this comment.
In addition, I think we should call out that they can capture a Zeebe user task ID, which they will use to assign/unassign in this API, from Tasklist....but it has to be a Zeebe task, not a legacy task.
We could link them to this doc, which describes the difference between zeebe user tasks & legacy user tasks. It's an important distinction that I personally overlooked, and I think it's likely that readers will do the same.
| } | ||
| ``` | ||
|
|
||
| 8. In your terminal, run `node cli.js zeebe assign <task id> <[email protected]>`, where `<task id>` is the Zeebe user task ID, and `<[email protected]>` is the assignee's email address. |
There was a problem hiding this comment.
🗒️ if you were wondering, like me, what would happen if one assigned a task via the API to a user not in their organization, the answer is:
It will work just fine.
| } | ||
| ``` | ||
|
|
||
| 8. In your terminal, run `node cli.js zeebe assign <task id> <[email protected]>`, where `<task id>` is the Zeebe user task ID, and `<[email protected]>` is the assignee's email address. |
There was a problem hiding this comment.
Also, I don't have a specific suggestion, but this might also be a good place to specify where they got a Zeebe user task ID from. ("The ID you've captured from Tasklist" or something like that)
|
This is ready for final review 👍 |
Description
Zeebe API docs tutorial -- relates to https://github.com/camunda/developer-experience/issues/142 and camunda/camunda-api-tutorials#8.
When should this change go live?
holdlabel or convert to draft PR)PR Checklist
/versioned_docsdirectory./docsdirectory (aka/next/).