Tasklist Public API (GraphQL)

Number of APIs: 2

🚀 Overview

Build apps powered by BPMN that require human interaction and make requests.

The GraphQL API is deprecated. To ensure a smooth transition, we'll continue to support our GraphQL API for a period of time, giving you an opportunity to migrate to the new REST API version at your own pace.

Review the Tasklist REST API. The REST API offers more functionality than the GraphQL API, and a more streamlined and efficient way of interacting with our service.

💪 What do you need to make it work?

Review the new Tasklist REST API. This API offers the same functionality as the current GraphQL API, but with a more streamlined and efficient way of interacting with our service.

The GraphQL API will be deprecated in the near future. To ensure a smooth transition, we'll continue to support our GraphQL API for a period of time, giving you an opportunity to migrate to the new REST API version at your own pace. We will provide further details on the timeline and process for this migration soon.

Endpoint​

Tasklist provides a GraphQL API at endpoint /graphql.

From Camunda 8 the endpoint is ${base-url}/graphql.

For SaaS: https://${REGION}.tasklist.camunda.io:443/${CLUSTER_ID}/graphql, and for Self-Managed installations: http://localhost:8080/graphql.

Authentication in the cloud​

To access the API endpoint, you need an access token.

Your client must send a header in each request:

Authorization: Bearer

For example, send a request using curl:

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer <TOKEN>" -d &#x27;{"query": "{tasks(query:{}){name}}"}&#x27; http://localhost:8080/graphql

How to obtain the access token​

You must obtain a token to use the Tasklist API. When you create a Tasklist client, you get all the information needed to connect to Tasklist.

Refer to our guide on building your own client.

The following settings are needed:

Send a token issue POST request to the authorization server with the following content:

{  "client_id": "<client-id>",  "client_secret": "<client-secret>",  "audience": "<audience>",  "grant_type": "client_credentials"}

Refer to the following example with curl:

curl -X POST --header &#x27;content-type: application/json&#x27; --data &#x27;{"client_id": "<client-id>", "client_secret":"<client-secret>","audience":"<audience>","grant_type":"client_credentials"}&#x27; https://<authorization server url>

If the authorization is successful, the authorization server sends back the access token, when it expires, scope, and type:

{  "access_token": "ey...",  "scope": "...",  "expires_in": 86400,  "token_type": "Bearer"}

Authentication for Self-Managed cluster​

The authentication is described in Tasklist Configuration - Authentication.

Obtaining the Tasklist schema​

To obtain the Tasklist GraphQL schema, send a request to the endpoint with a GraphQL introspection query as described here, or use the generated API documentation.

There are also several tools to explore GraphQL APIs.

For example, you want to know about provided types:

query {  __schema {    queryType {      fields {        name        type {          kind          ofType {            kind            name          }        }      }    }  }}

Example requests and responses​

Get all task names​

Request:

{  tasks(query: {}) {    name  }}

Response:

{  "data": {    "tasks": [      {        "name": "Check payment"      },      {        "name": "Register the passenger"      }    ]  }}

Get all tasks completed with id, name, and state​

Request:

{  tasks(query: { state: COMPLETED }) {    id    name    taskState  }}

Response:

{  "data": {    "tasks": [      {        "id": "2251799813685728",        "name": "Check payment",        "taskState": "COMPLETED"      }    ]  }}

1. mutations - startProcess POST {{url}}

2. queries - processes POST {{url}}