API

PreviousStep-by-Step Guide to Enable In-App Actions NextWidget

Last updated 3 months ago

Creates an event log for the occurance of an event

post

v1/events/logs

Authorizations

Header parameters

x-api-keystringrequired

Your platform API key

Body

identityIdstringrequired

The identity ID corresponding to the user

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

eventIdstringrequired

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://{your-subdomain}.heymint.quest/api/v1/events/logs' \
  --header 'x-api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "identityId": "48d0e4d6-ebeb-492d-a4c5-643864db18fb",
    "eventId": "37aff86c-fb50-40cb-8785-0629c38c4f4c",
    "uniqueIdentifier": "abcd1234"
  }'

200

400

401

405

500

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

200 OK

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

post

v1/identities/{identityId}/association

Authorizations

Path parameters

identityIdstringrequired

Header parameters

x-api-keystringrequired

Your platform API key

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://{your-subdomain}.heymint.quest/api/v1/identities/{identityId}/association' \
  --header 'x-api-key: text'

200

400

401

405

500

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

200 OK

Creates a new identity

post

v1/identities

Authorizations

Header parameters

x-api-keystringrequired

Your platform API key

Body

uniqueIdentifierstring

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

Example: abcd1234

providerInfoobject

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://{your-subdomain}.heymint.quest/api/v1/identities' \
  --header 'x-api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "uniqueIdentifier": "abcd1234",
    "providerInfo": {
      "ethAddress": "text",
      "twitterUsername": "text",
      "discordId": "text",
      "googleId": "text",
      "emailAddress": "text"
    }
  }'

200

400

401

405

500

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

200 OK

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

post

v1/events

Authorizations

Header parameters

x-api-keystringrequired

Your platform API key

Body

namestring · min: 1required

Name of the event

Example: Level Up

slugstring · min: 1 · max: 60required

Event slug (used to call the event log api)

Example: level_up

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://{your-subdomain}.heymint.quest/api/v1/events' \
  --header 'x-api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Level Up",
    "slug": "level_up"
  }'

200

400

401

405

500

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

200 OK

Creates an event log for the occurance of an event

post

v1/events/logs

Authorizations

Header parameters

x-api-keystringrequired

Your platform API key

Body

all of

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://{your-subdomain}.heymint.quest/api/v1/events/logs' \
  --header 'x-api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "eventId": "level_up",
    "uniqueIdentifier": "abcd1234",
    "identityId": "text"
  }'

200

400

401

405

500

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

200 OK

List event logs

get

v1/events/logs

Authorizations

Query parameters

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 · min: 1 · max: 200 · default: 100

The maximum number of log entries to return

Header parameters

x-api-keystringrequired

Your platform API key

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://{your-subdomain}.heymint.quest/api/v1/events/logs' \
  --header 'x-api-key: text'

200

400

401

405

500

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

200 OK

API

API

Identities

Create identity

Create identity association URL

Events

Create an event

Log an event

List event logs

Identities

Create identity

Create identity association URL

Events

Create an event

Log an event

List event logs