Skip to main content

Start using the API

GraphQL​

Our API uses GraphQL to serve requests over HTTPS and WebSockets.
You can learn more about GraphQL here.

API URLs​

You can interact with the API by using the following URL: https://api.hacksessible.com/graphql

If you want to play with the API and have more precise documentations, we provide a Playground through the following URL: https://api.hacksessible.com/graphql.

Required headers​​

To be able to interact with the API, you will need to send the header organization-id with all your requests to the API and setting its value to the ID of the Organization you want your app to be able to interact with.
This header is not needed when the organizationId is requested directly in the input body.

Example​

curl -X POST -H 'organization-id: ORGANIZATION_ID_HERE' \
  -d '{...}' https://api.hacksessible.com/graphql

Authentication​

Using the API can be done through API keys methods.

Start by creating an API key

  • Open the console menu for API keys management
  • Select the group you wish to assign to your API key. Note that all permissions associated with the group will be applyed to the API key.
  • Set the authorization header, on all your requests to authorization: ApiKey <your_api_key>.

You are now succesfully authenticated to the API!

Example​

curl -X POST -H 'organization-id: ORGANIZATION_ID_HERE' -H 'authoization: ApiKey api_key_xxxxxx' \
  -d '{...}' https://api.hacksessible.com/graphql