---
name: bijection-invitations
description: "Evaluate and integrate the Invitations component with Bijection."
---

# Invitations

Invite → accept → expire flow — issue a single-use, expiring invitation to a resource and consume it, as a Bijection component

- Package: @bijectionhq/invitations
- Category: Collaboration
- Status: Preview
- License: MIT
- Bijection source (repository access required): https://github.com/bijectionhq/invitations/tree/c9c8c0921d2d0f69f4876f470d2da7418abeb2fa
- Upstream: https://github.com/vllnt/convex-invitations/tree/ebbf6c481acc35f08cacb9207c0daad986426054
- Documentation: https://docs.bijection.com/components/using
- Directory: https://bijection.com/components/invitations

## Get the source

Bijection repository access is required. Request access at https://bijection.com/contact.

```sh
git clone https://github.com/bijectionhq/invitations.git
cd invitations
git checkout c9c8c0921d2d0f69f4876f470d2da7418abeb2fa
```

## Before using this component

Read the package README at the recorded revision for setup, dependencies, and API examples. Upstream documentation describes the original package and may differ from the Bijection adaptation. This is a source candidate for evaluation. Catalog inclusion does not establish npm availability or runtime qualification. Check compatibility with your SDK and deployment before adoption. External providers run their own compute.

## Integration workflow

1. Read the source README and package manifest at the recorded revision.
2. Confirm the required SDK, dependency availability, and runtime compatibility.
3. Follow the component's documented setup and configuration. Never invent an npm install command from a catalog package name.
4. Keep credentials in the project's existing secret store.
5. Follow the project's execution rules for verification and report what was actually checked.

## Original upstream skill

The following guidance describes @vllnt/convex-invitations. Its installation commands and APIs refer to the upstream package. Evaluate compatibility with the Bijection source separately.


> Agents: read this skill fully before writing code that uses Invitations. Follow the installation and configuration steps exactly.

# Invitations

## Instructions

@vllnt/convex-invitations manages the lifecycle of an invitation independently of the resource being shared. Your app supplies the resource reference and typed role or payload, then decides how to deliver and apply the invitation.

issue returns a token and expiry. accept consumes a valid invitation and returns the grant for the host to apply. revoke cancels pending invitations; accepted, revoked, and expired states are terminal. Queries list invitations by resource and state.

Your backend authenticates the recipient, authorizes the action, delivers the link, and applies the returned grant. The component does not send email or create membership automatically. Coordinate acceptance and the host-side grant so failures cannot leave the user without the intended access.

Maintained by [bntvllnt](https://bntvllnt.com) at [VLLNT](https://vllnt.com). Find the author on [GitHub](https://github.com/bntvllnt) and [X](https://x.com/bntvllnt).

### Installation

```bash
npm install @vllnt/convex-invitations
```

Current npm version: `@vllnt/convex-invitations@0.1.0`

## Use cases

- SaaS onboarding: invite a colleague to a workspace with a proposed role.
- Education: offer access to a course or learning group.
- Games and communities: invite someone to a team or guild.
- Collaboration: share access to a project or document through an expiring link.

## How it works

issue returns a token and expiry. accept consumes a valid invitation and returns the grant for the host to apply. revoke cancels pending invitations; accepted, revoked, and expired states are terminal. Queries list invitations by resource and state.

Your backend authenticates the recipient, authorizes the action, delivers the link, and applies the returned grant. The component does not send email or create membership automatically. Coordinate acceptance and the host-side grant so failures cannot leave the user without the intended access.

## When NOT to use

- When a simpler built-in solution exists for your specific use case
- If you are not using Convex as your backend
- When the functionality provided by Invitations is not needed

## Resources

- [npm package](https://www.npmjs.com/package/%40vllnt%2Fconvex-invitations)
- [GitHub repository](https://github.com/vllnt/convex-invitations)
- [Live demo](https://vllnt.com/)
- [Convex Components Directory](https://www.convex.dev/components/vllnt/convex-invitations)
- [Convex documentation](https://docs.convex.dev)