Evolving badges & Holobytes

Evolving badges are issued in the form of holobytes. Holobytes are progress points. When a recipient receives a holobyte, their evolving badge's image changes to reflect their progress. The recipient can continue to earn holobytes, and their badge will continue to evolve.

Holobytes can also be issued without an evolvingStickerid. In this case, the holobyte will be issued on its own, and the recipient will not be able to use it to evolve a badge. This is useful for issuing holobytes as small ad-hoc rewards as kudos.

Via the Holopin API

Unique Holobytes

POST https://www.holopin.io/api/holobyte?id=[evolvingStickerid]&apiKey=[apiKey]

[evolvingStickerid] is the id of the evolving badge ID you want to issue a holobyte for. This can be found in the URL of the evolving badge's page.

If you are not issuing a holobyte towards an evolving badge, you can omit this parameter.

Options for the body of the request:

Option	Type	Description
username	string	Holopin username of the recipient
icon	string	Icon for the holobyte. Available options: "lemon", "cherry", "coffee", "starfuit", "avodado". Defaults to "lemon"
description	string	What the holobyte was issued for. Will appear as "@username has earned a holobyte from [organization] for [description]..."
url	string	URL reference of where the holobyte was earned. Will appear as "@username has earned a holobyte from [organization] in [urlAlias]..."
urlAlias	string	Alternative name for the URL reference
toGithubId	string	Github ID of the recipient
toDiscordId	string	Discord ID of the recipient
fromAlias	string	A specific person's or team's (user)name who you want to appear as the issuer. By default, this is your Holopin organization name.
fromAliasUrl	string	A URL reference for the issuer. It can be their Holopin account, GitHub profile, or website — anything that you want to link to.
metadata	string	Metadata of the holobyte. This is optional

The body of the request can contain any combination of the above, but must contain at least one of username, toGithubId, or toDiscordId or none of them to create a Holobyte that can be claimed by anyone.

Success response (with evolvingStickerid):

{
    "id": [holobyteId],
    "evolvingStickerId": [evolvingStickerId],
    "metadata": [metadata] // only if the metadata parameter was used
}

Success response (without evolvingStickerid):

{
    "id": [holobyteId],
    "metadata": [metadata] // only if the metadata parameter was used
}

Holobytes can be claimed by a specific recipient by using the id of the holobyte in this URL:

https://www.holopin.io/holobyte/[holobyteId]

In cases where the user with the associated Github or Discord ID has already connected their Holopin account, the holobyte will appear in their profile automatically.

Holobytes via Multi-Claim URL

For marketing campaigns, Easter eggs, and other special occasions, you can issue holobytes via a multi-claim URL. This URL can be shared with a group of people.

POST https://www.holopin.io/api/multiholobyte?id=[evolvingStickerid]&apiKey=[apiKey]

[evolvingStickerid] is the id of the evolving badge ID you want to issue a holobyte for. This can be found in the URL of the evolving badge's page.

If you are not issuing a holobyte towards an evolving badge, you can omit this parameter.

Options for the body of the request:

Option	Type	Description
icon	string	Icon for the holobyte. Available options: "lemon", "cherry", "coffee", "starfuit", "avodado". Defaults to "lemon"
description	string	What the holobyte was issued for. Will appear as "@username has earned a holobyte from [organization] for [description]..."
url	string	URL reference of where the holobyte was earned. Will appear as "@username has earned a holobyte from [organization] in [urlAlias]..."
urlAlias	string	Alternative name for the URL reference
fromAlias	string	A specific person's or team's (user)name who you want to appear as the issuer. By default, this is your Holopin organization name.
fromAliasUrl	string	A URL reference for the issuer. It can be their Holopin account, GitHub profile, or website — anything that you want to link to.
slug	string	A unique identifier for the multi-claim URL. If you don't specify a slug, you can still issue it via ID
metadata	string	Metadata of the holobyte. This is optional

Success response:

{
    "id": [multiholobyteId],
    "slug": [slug], // if not in request, this will be null
    "evolvingStickerId": [evolvingStickerId], // if not in request, this will be null
    "metadata": [metadata] // only if the metadata parameter was used
}

Holobytes can be claimed from a Multi-Claim URL by using the id of the holobyte in this URL:

https://www.holopin.io/holobyte/collect/[holobyteId]

Last updated on February 28, 2024

Creating badges Regular Badges