Our GraphQL API documentation can be found at developer.launchnotes.com.

LaunchNotes was made with collaboration and communication across teams at the heart of what we do. Collaboration across tools and teams works best when everyone stays in sync and processes work seamlessly.

This article will discuss the following:

GraphQL
API documentation
API authentication
Interacting with the API
Access limitations
REST API

GraphQL

We use GraphQL for our API, which provides powerful functionality and flexibility.

💡 Tip: If you're unfamiliar with GraphQL, you can find out more about it here: https://graphql.org/

API documentation

Our API documentation can be found at https://developer.launchnotes.com/index.html. You can search the different Operations (queries and mutations) and Types in the left hand navigation bar, which will bring up the relevant fields, nodes, and implementations:

API Authentication

Creating an API token

To interact with our API, you'll need to generate an API token. This can be found under Settings > API, Embed & RSS in the LaunchNotes management portal, and selecting the Create API Token button.

There are two types of API tokens: Read-only and Management:

Read-only Public tokens

Read-only

This API user can only read in public Announcements. Perfect for embedding published Announcements into your web app using our v1 pop-over embed or with a custom implementation.

Management API tokens

Management API tokens provide read and write access to your project. These tokens should never be shared publicly and are suitable for server-side use cases where you might want to automate the creation of content or build custom integrations.

The GraphQL endpoint

https://app.launchnotes.io/graphql

The endpoint is the same for all operations, regardless of token type.

Using an API token

You must provide an API token as a Bearer token for every request to the API.

For example:

curl 'H "Authorization: Bearer public_QKHLUeWw6HxyE5cq9nujHqqX" \ 
    -X POST -d " \ 
    { \ 
      \"query\": \"query { viewer { id }}\" \ 
    } \ 
" https://app.launchnotes.io/graphql

Interacting with the API

Entrypoint

All operations should be made through the viewer field.

For example, querying a project's categories:

query GetCategories {  
  viewer { 
    project(id: "your_project_id") {
      categories { 
        nodes { 
          id 
          name 
          description
          color 
        } 
      }
    } 
  } 
}

Creating an Announcement:

mutation useCreateAnnouncement_Mutation ($projectId: ID!) {
  createAnnouncement(input: { announcement: { projectId: $projectId }                  }) {
    announcement {
      id
    }
    errors {
      message
      path
    }
  }
}

Updating an Announcement:

mutation useUpdateAnnouncement_Mutation ($announcement: UpdateAnnouncementAttributes!) {
  updateAnnouncement(input: { announcement: $announcement }) {
    announcement {
      id
      headline
    }
    errors {
      message
      path
    }
  }
}

Access limitations

Rate limit

An API token can run a maximum of 300 operations every 5 minutes. For high volume use cases, we recommend caching results on your end to avoid being throttled by the rate limit.

REST API for Announcements

In addition to our GraphQL API, LaunchNotes offers a REST API to fetch announcements, track unread counts, and record views.

Base URL: https://app.launchnotes.io

Endpoints:

• GET /embed/unread – Retrieve unread announcement counts

• GET /embed/announcement_list – Fetch a list of announcements

• POST /embed/announcements/track_open – Track when announcements are opened

All endpoints support JSON responses and require a valid token and projectId. Optional parameters (such as anonymousUserId and categories) can further customize your results.

For more details on the REST API, please reach out to our team.

We're here to help!

✉️ If you have any questions or suggestions for our API and API documentation,

please get in touch with us at [email protected].