Skip to content

Use custom emoji with GraphQL

DETAILS: Tier: Free, Premium, Ultimate Offering: GitLab.com, Self-managed, GitLab Dedicated

To use custom emoji in comments and descriptions, you can add them to a top-level group by using the GraphQL API.

Create a custom emoji

mutation CreateCustomEmoji($groupPath: ID!) {
  createCustomEmoji(input: {groupPath: $groupPath, name: "party-parrot", url: "https://cultofthepartyparrot.com/parrots/hd/parrot.gif"}) {
    clientMutationId
    customEmoji {
      name
    }
    errors
  }
}

After you add a custom emoji to the group, members can use it in the same way as other emoji in the comments.

Attributes

The query accepts these attributes:

Attribute Type Required Description
group_path integer/string Yes ID or URL-encoded path of the top-level group.
name string Yes Name of the custom emoji.
file string Yes URL of the custom emoji image.

Use GraphiQL

You can use GraphiQL to query the emoji for a group.

  1. Open GraphiQL:

    • For GitLab.com, use: https://gitlab.com/-/graphql-explorer
    • For self-managed GitLab, use: https://gitlab.example.com/-/graphql-explorer

  2. Copy the following text and paste it in the left window. In this query, gitlab-org is the group path.

        query GetCustomEmoji {
      group(fullPath: "gitlab-org") {
        id
        customEmoji {
          nodes {
            name,
            url
          }
        }
      }
    }

  3. Select Play.

Related topics