API

Identities

Create identity

Creates a new identity

POSThttps://{your-subdomain}.heymint.quest/api/v1/identities

Header parameters

Body

application/json

uniqueIdentifierstring

Your own unique identitier for this identity. If the same unique identifier is used multiple times, the same identity will be returned.

Example: "abcd1234"

Response

200400401405500

200 OK

Body

application/json

id*string

The newly created identity ID

Example: "48d0e4d6-ebeb-492d-a4c5-643864db18fb"

Request

JavaScriptCurlPython

const response = await fetch('https://{your-subdomain}.heymint.quest/api/v1/identities', {
    method: 'POST',
    headers: {
      "x-api-key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400401405500

{
  "id": "48d0e4d6-ebeb-492d-a4c5-643864db18fb"
}

Create identity association URL

Generates a url that can be shared with a user to associate an identity with their account on the platform

POSThttps://{your-subdomain}.heymint.quest/api/v1/identities/{identityId}/association

Path parameters

identityId*string

Header parameters

Response

200400401405500

200 OK

Body

application/json

identityId*string

The identity ID corresponding to the user

Example: "48d0e4d6-ebeb-492d-a4c5-643864db18fb"

url*string (uri)

The url to share with the user to claim the identity and associate it with their platform account

Example: "https://quest.heymint.xyz/claim-identity/0cd929f4-8420-4d99-845d-fa4a24cfb32f:48d0e4d6-ebeb-492d-a4c5-643864db18fb:abcd1234"

Request

JavaScriptCurlPython

const response = await fetch('https://{your-subdomain}.heymint.quest/api/v1/identities/{identityId}/association', {
    method: 'POST',
    headers: {
      "x-api-key": "text"
    },
});
const data = await response.json();

Response

200400401405500

{
  "identityId": "48d0e4d6-ebeb-492d-a4c5-643864db18fb",
  "url": "https://quest.heymint.xyz/claim-identity/0cd929f4-8420-4d99-845d-fa4a24cfb32f:48d0e4d6-ebeb-492d-a4c5-643864db18fb:abcd1234"
}

Events

Create an event

Creates a new event for an action that will take place outside of the platform

POSThttps://{your-subdomain}.heymint.quest/api/v1/events

Header parameters

Body

application/json

name*string

Name of the event

Example: "Level Up"

Response

200400401405500

200 OK

Body

application/json

id*string

The ID of the newly created event

Example: "17f8124a-08eb-499c-bf40-0779ef8fa6a6"

Request

JavaScriptCurlPython

const response = await fetch('https://{your-subdomain}.heymint.quest/api/v1/events', {
    method: 'POST',
    headers: {
      "x-api-key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "Level Up"
    }),
});
const data = await response.json();

Response

200400401405500

{
  "id": "17f8124a-08eb-499c-bf40-0779ef8fa6a6"
}

Log an event

Creates an event log for the occurance of an event

POSThttps://{your-subdomain}.heymint.quest/api/v1/events/logs

Header parameters

Body

application/json

identityId*string

The identity ID corresponding to the user

Example: "48d0e4d6-ebeb-492d-a4c5-643864db18fb"

eventId*string

The ID of the event to log

Example: "37aff86c-fb50-40cb-8785-0629c38c4f4c"

uniqueIdentifierstring

Your own unique identitier for this particular instance of the event taking place. If the same unique identifier is used multiple times for the same event, it will not create additional logs. This can be useful to ensure that you do not accidentally log the same event occurance more than once.

Example: "abcd1234"

Response

200400401405500

200 OK

Body

application/json

logId*string

The ID of the newly created log entry

Example: "cf35edb3-5567-4701-9720-3e48831d0dc0"

identityClaimed*boolean

Whether or not the provided identity has been claimed by a user yet

Example: true

Request

JavaScriptCurlPython

const response = await fetch('https://{your-subdomain}.heymint.quest/api/v1/events/logs', {
    method: 'POST',
    headers: {
      "x-api-key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "identityId": "48d0e4d6-ebeb-492d-a4c5-643864db18fb",
      "eventId": "37aff86c-fb50-40cb-8785-0629c38c4f4c"
    }),
});
const data = await response.json();

Response

200400401405500

{
  "logId": "cf35edb3-5567-4701-9720-3e48831d0dc0",
  "identityClaimed": true
}

List event logs

List event logs

GEThttps://{your-subdomain}.heymint.quest/api/v1/events/logs

Header parameters

Body

application/json

eventIdstring

An event ID (or a comma-separated list of IDs) to filter by

identityIdstring

An identity ID (or a comma-separated list of IDs) to filter by

afterstring

For cursor-based pagination, specify the id of the last log entry you've seen

limitnumber

The maximum number of log entries to return

Response

200400401405500

200 OK

Body

application/json

data*array of object

Request

JavaScriptCurlPython

const response = await fetch('https://{your-subdomain}.heymint.quest/api/v1/events/logs', {
    method: 'GET',
    headers: {
      "x-api-key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400401405500

{
  "data": [
    {
      "id": "text",
      "createdAt": "text",
      "event": {
        "id": "text",
        "name": "text"
      },
      "identity": {
        "id": "text"
      }
    }
  ]
}