PHPackages                             teamvortexsoftware/vortex-php-sdk - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Authentication & Authorization](/categories/authentication)
4. /
5. teamvortexsoftware/vortex-php-sdk

ActiveLibrary[Authentication & Authorization](/categories/authentication)

teamvortexsoftware/vortex-php-sdk
=================================

Vortex PHP SDK for authentication and invitation management

1.9.0(2mo ago)0233↓33.3%MITPHPPHP >=8.0

Since Oct 31Pushed 2mo agoCompare

[ Source](https://github.com/TeamVortexSoftware/vortex-php-sdk)[ Packagist](https://packagist.org/packages/teamvortexsoftware/vortex-php-sdk)[ RSS](/packages/teamvortexsoftware-vortex-php-sdk/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependencies (1)Versions (12)Used By (0)

Vortex PHP SDK
==============

[](#vortex-php-sdk)

This package provides the Vortex PHP SDK for authentication and invitation management.

With this SDK, you can generate JWTs for use with the Vortex Widget and make API calls to the Vortex API.

Features
--------

[](#features)

### Invitation Delivery Types

[](#invitation-delivery-types)

Vortex supports multiple delivery methods for invitations:

- **`email`** - Email invitations sent by Vortex (includes reminders and nudges)
- **`phone`** - Phone invitations sent by the user/customer
- **`share`** - Shareable invitation links for social sharing
- **`internal`** - Internal invitations managed entirely by your application
    - No email/SMS communication triggered by Vortex
    - Target value can be any customer-defined identifier (UUID, string, number)
    - Useful for in-app invitation flows where you handle the delivery
    - Example use case: In-app notifications, dashboard invites, etc.

Installation
------------

[](#installation)

Install the SDK via Composer:

```
composer require teamvortexsoftware/vortex-php-sdk
```

Getting Started
---------------

[](#getting-started)

Once you have the SDK installed, [login](https://admin.vortexsoftware.com/signin) to Vortex and [create an API Key](https://admin.vortexsoftware.com/members/api-keys). Keep your API key safe! Vortex does not store the API key and it is not retrievable once it has been created.

Your API key is used to:

- Sign JWTs for use with the Vortex Widget
- Make API calls against the [Vortex API](https://api.vortexsoftware.com/api)

Usage
-----

[](#usage)

### Generate a JWT for the Vortex Widget

[](#generate-a-jwt-for-the-vortex-widget)

The Vortex Widget requires a JWT to authenticate users. Here's how to generate one:

```