Skip to content

Contributing an integration

You can build an integration that connects Tangled to a different service using the public API or by simply listening for events on a firehose. If you write an integration, get in touch, and we could get it documented here!

Each repository has its own DID. The records of a repository, for example issues, pull requests and artifacts, can be filtered and streamed using Jetstream.

Some records are owned by users, and not repositories. For example, a star is in the repository of the user that gives the star.

Refer to Records for the record types.

Use the Bobbin API at https://api.tangled.org to get data that is not in the records. For example:

  • org.tangled.repo.getRepoByName gives the DID of a repository.
  • org.tangled.temp.git.listTags gives the tags and their messages.
  • org.tangled.feed.countStars gives the star count.

When your integration is ready, add a page for it here:

  1. Add a Markdown file in docs/src/content/docs/integrations/.
  2. Add the page to the Integrations section of the sidebar in docs/astro.config.mjs.
  3. Tell users how to install the integration and how to use it. Keep the page short.
  4. Send a pull request. Refer to the Contribution guide.