Settings

This page is for whoever looks after your organisation’s Keliplay account, and for anyone who wants to update their own profile. Choose Settings in the sidebar. It has six sections: Your profile, API keys, Allowed origins, Webhooks, Members and Roles.

What you can see and change here depends on your role.

Your profile

Your profile belongs to you, not to an organisation, so it stays the same when you switch organisation. You can also open it from Your profile in the account menu.

Name and picture

• Display name: how your teammates see you.
• Picture: choose Upload a picture. PNG, JPEG or WebP, up to 2 MB. Use Replace or Remove to change it.

Choose Save profile.

Your Email address is your sign-in address and cannot be changed here. To use a different address, ask an owner to invite the new one.

Password

Enter your Current password, a New password of at least 8 characters, and Repeat new password. Choose Change password. This signs you out everywhere else.

API keys

API keys let your own backend talk to Keliplay, for example to ask for the client token every embed needs. See Authentication.

Create a key

1. Choose Create key.
2. Enter a Name that says what the key is for, such as “Production backend”.
3. Under What this key may do, tick the permissions the key needs. A new key starts with View campaigns and Issue player tokens, which is enough to embed games. Give a key only what it needs. You can only give a key permissions your own role has; the others are greyed out. Ask an owner to create a key that needs them.
4. Choose Create.
5. In Copy this key now, copy the key and store it on your server. Choose Done.

Caution

This is the only time the full key is shown. If you lose it, revoke it and create a new one. Never put a key in a web page or an app.

A key can hold any permission except managing people and roles.

The table shows each key’s Name, Prefix (the start of the key, to tell keys apart), Status, Permissions and when it was Last used.

Revoke a key

Choose Revoke next to the key and confirm. Anything using the key stops working immediately. This cannot be undone.

Your plan sets how many active keys you can have, and whether API keys are included at all. Revoking a key frees its place straight away. See Plans.

Allowed origins

Keliplay only issues a token for a place you have listed here. If a site or app is not on the list, games do not load there.

1. Choose Add origin.
2. Pick the Platform: Web, Android app or iOS app.
3. Enter:
   • for Web, in Origin, the site’s address with https:// and no path, such as https://www.example.com. Add each address separately, for example with and without www.
   • for Android app, in Application ID, the app’s id, such as com.example.app. It is listed as android:com.example.app.
   • for iOS app, in Bundle ID, the app’s bundle id. It is listed as ios:com.example.app.
4. Choose Add origin.

An app that uses the same id on Android and iOS is added once for each. Flutter and React Native apps that show games in a web view add the website that serves the page instead. See Mobile apps.

To remove one, choose Remove and confirm. Tokens can no longer be issued for it.

You can also add web addresses from a channel’s Embed tab.

Webhooks

Webhooks send events to your own systems as they happen. Developers can read how to receive them in Webhooks.

Add an endpoint

1. Choose Add endpoint.
2. Enter the URL that should receive events.
3. Under Events, turn on the ones you want:
   • session_completed: a play finished. Sent for every play, won or not.
   • winner_selected: a draw picked winners.
   • reward_granted: a player received a reward code.
4. If you turned on reward_granted and this endpoint delivers coupons to players, turn on Include coupon codes to receive each coupon’s code. You need the Add, generate and withdraw coupon codes permission to do this. See Receive coupon codes.
5. Under Campaigns, keep All campaigns, or pick the campaigns this endpoint should hear about.
6. Choose Add.
7. In Copy this signing secret now, copy the secret and give it to your developers. They use it to check that each delivery came from Keliplay. Choose Done.

Caution

The signing secret is shown only once.

Manage endpoints

• Choose Edit to change an endpoint’s events, Include coupon codes and campaigns. The URL cannot be changed; to use a different one, add a new endpoint.
• Choose an endpoint’s Campaigns cell to change which campaigns it hears about.
• Use the Active switch to pause and resume deliveries.
• Use the Coupon codes switch to start or stop sending coupon codes in reward_granted events. Turning it on asks you to confirm.
• Choose the delete button and confirm to remove an endpoint. Its delivery history is removed with it; to keep the history, turn the endpoint off instead.

Delivery log

Recent deliveries lists every event sent, with its Status: Delivered, Failed, Pending or Given up, and how many Attempts it took. Search by event type or filter by status. Choose a delivery to see what was sent (Payload) and the HTTP status your system answered with. Coupon codes never appear in the payload shown here, even for an endpoint that receives them.

Your plan sets whether webhooks are included and how many endpoints you can have.

Members

Members lists everyone in the organisation, with their Name, Email and Role.

Invite someone

1. Choose Invite teammate.
2. Enter their Email and pick a Role.
3. Choose Send invitation.

They receive an email with a link to join. See Join with an invitation.

Pending invitations lists invitations not yet accepted, with when each Expires. Choose Cancel to withdraw one.

Change a role or remove someone

Pick a new role in a member’s Role column. To remove someone, open the actions menu on their row, choose Remove and confirm. They lose access straight away.

The organisation’s founder holds the Owner role, which is locked and cannot be changed.

Your plan sets how many people your organisation can have.

Roles

A role is a name and a set of permissions. Every member has one role.

Built-in roles

Every organisation starts with three roles:

Role	What it can do
Owner	Everything. Marked Locked: it cannot be edited or deleted.
Admin	Everything except creating and editing roles, and a few actions kept for the owner.
Member	View campaigns, browse the media library, see entries and winners, see reward settings and who received one, issue player tokens, and view account settings.

Admin and Member are starting points. Users who can manage roles can edit their permissions.

Custom roles

On plans that include custom roles, you can create your own, such as “Marketing”.

1. Choose New role.
2. Enter a Name.
3. Under What this role may do, tick its permissions. You can only grant permissions your own role has.
4. Choose Save role.

Use Edit to change a role, and Delete to remove it. You cannot delete a role while people hold it. Move them to another role first.

If somebody deletes or renames the role you hold, you see Your role was removed and nothing loads until an owner gives you a new role.

Permissions

Area	Permission
Campaigns	View campaigns
	Create and edit campaigns
	Make a campaign live
	Delete a campaign for good
	Declare a prediction’s real outcome
Channels	Create and edit channels
Game setup	Change a game’s rules
Branding	Change colours, logo and type
Copy	Change player-facing wording
Pre-game page	Arrange the pre-game page
Media library	Browse the media library
	Upload files and organise folders
	Delete files for good
Results	See entries and winners
Draws	Run a winner draw
Player tokens	Issue player tokens
Rewards	See reward settings and who received one
	Set up rewards and the reward page
	Add, generate and withdraw coupon codes
	Give a reward to a player by hand
API keys	Create and revoke API keys
Allowed origins	Change where games may load
Webhooks	Manage webhook endpoints
Settings	View account settings
People	See who is in the organisation
	Invite and remove people
Roles	Create and edit roles