Use custom emoji with GraphQL

{{< details >}}

• Tier: Free, Premium, Ultimate
• Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated

{{< /details >}}

{{< history >}}

• Introduced in GitLab 13.6 with a flag named custom_emoji. Disabled by default.
• Enabled on GitLab.com in GitLab 14.0.
• Enabled on GitLab Self-Managed in GitLab 16.7.
• Generally available in GitLab 16.9. Feature flag custom_emoji removed.

{{< /history >}}

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:

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 GitLab Self-Managed, 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.

   graphqlCopy

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

3. Select Play.

Related topics

• GraphQL API reference
• GraphQL-specific entities, like fragments and interfaces