Use custom emoji with GraphQL (FREE ALL)

  • Introduced in GitLab 13.6 with a flag named custom_emoji. Disabled by default.
  • Enabled on GitLab.com in GitLab 14.0.

FLAG: On self-managed GitLab, by default this feature is not available. To make it available, an administrator can enable the feature flag named custom_emoji. On GitLab.com, this feature is available. This feature is ready for production use.

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

Parameters:

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

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 adding a custom emoji to the group, members can use it in the same way as other emoji in the comments.

Get custom emoji for a group

query GetCustomEmoji($groupPath: ID!) {
  group(fullPath: $groupPath) {
    id
    customEmoji {
      nodes {
        name
      }
    }
  }
}

Set up the GraphiQL explorer

This procedure presents a substantive example that you can copy and paste into GraphiQL explorer. GraphiQL explorer is available for:

  1. Copy the following code excerpt:
    query GetCustomEmoji {
      group(fullPath: "gitlab-org") {
        id
        customEmoji {
          nodes {
            name,
            url
          }
        }
      }
    }
  1. Open the GraphiQL explorer tool.
  2. Paste the query listed above into the left window of your GraphiQL explorer tool.
  3. Select Play to get the result shown here:

GraphiQL explore custom emoji query

For more information on: