Quickstart
Create your first invite in under five minutes.
Get your API key
Grab a test-mode API key from the dashboard. Test
keys are prefixed with ib_test_ and never touch live data.
Create an invite
import { Invitebase } from '@invitebase/node';
const invitebase = new Invitebase(process.env.INVITEBASE_API_KEY);
const invite = await invitebase.invites.create({
campaign: 'launch-waitlist',
inviter: { externalId: 'user_123' },
maxUses: 5,
});
console.log(invite.url); // https://go.invitebase.com/i/8f3kz2curl https://api.invitebase.com/v1/invites \
-H "Authorization: Bearer $INVITEBASE_API_KEY" \
-d campaign=launch-waitlist \
-d "inviter[external_id]=user_123" \
-d max_uses=5from invitebase import Invitebase
client = Invitebase(api_key=os.environ["INVITEBASE_API_KEY"])
invite = client.invites.create(
campaign="launch-waitlist",
inviter={"external_id": "user_123"},
max_uses=5,
)
print(invite.url)Handle the redemption
When someone accepts the invite, Invitebase fires an invite.redeemed webhook:
{
"type": "invite.redeemed",
"data": {
"invite_id": "inv_8f3kz2",
"campaign": "launch-waitlist",
"inviter": { "external_id": "user_123" },
"invitee": { "external_id": "user_456" }
}
}See Webhooks for signature verification and retries.