Skip to main content

GeckoEngage Integration

What credentials we need from GeckoEngage, API tokens for a dedicated API user, EU/US region selection, and field ID mapping.

GeckoEngage is Uni Compare's native-supported engagement platform. The integration uses an API token issued to a dedicated API user in your GeckoEngage account.

GeckoEngage is fully supported by Uni Compare, and connects through an API token created under a dedicated API user in your account.

What we need from you

  • Three GeckoEngage tokens (Access token, ID token, Refresh token), all generated together in the same token creation flow, issued under a dedicated API user.

  • Confirmation of your region: European Union (gecko.api.geckoengage.com) or United States (gecko.api.geckoengage.us).

  • A table of Field IDs. For each field we populate (see Field mapping below), tell us the numeric Field ID in your tenant. Gecko identifies all Contact fields by numeric ID. See Step 5 for how to find them.

  • A heads-up if GeckoEngage already pushes leads onwards from Gecko to another CRM on your side via Gecko's own outbound webhook. See the FAQ below.


Where in GeckoEngage to set it up

Step 1. Create the API user group

In your GeckoEngage admin settings, create a user group called "API Users" (or similar). Grant minimum permissions: Contacts (View, Create, Update). The user group's permissions act as a ceiling on what the API token can do, and you can further restrict per-token in Step 4.

Step 2. Create the dedicated API user

Create a new user assigned to the "API Users" group from Step 1. Use a generic name like "Uni Compare API" and a strong password. Store the password in a password manager, since you'll only need it once to log in and create the tokens.

Step 3. Log in as the API user

Log out of your current admin session and log in to GeckoEngage as the dedicated API user. This step is critical: the tokens you create in Step 4 are associated with the logged-in user, so they must be generated from the API user's session, not your regular admin account.

Step 4. Create the API token

Once logged in as the API user, open Security Preferences → API tokens, or go directly to account.geckoengage.com/account/active-sessions. Click "Create New API Token", then:

  • Give the token a descriptive name (e.g. "Uni Compare lead delivery").

  • Select the profile to generate API access for (typically the API user's own profile).

  • Select only the permissions needed: Contacts (View, Create, Update). Selecting permissions the API user doesn't have through their group will have no effect.

  • After creation, go to Active sessions (left menu) and copy all three tokens immediately: Access, ID, and Refresh. Gecko shows them once. Treat all three like passwords.

Step 5. Collect the Field IDs

Gecko identifies every Contact field by a numeric Field ID, both built-in fields (first name, email, etc.) and custom attributes. Go to Contacts → Settings → Field management → Contact fields and groups. For each field listed in the Field mapping section below, send us its Label + Field ID pair. The Field ID is not displayed in the list. Click into a field to edit it, and the ID is the number at the end of the URL. For example, https://app.geckoengage.com/admin/settings/contact_fields/36 means the Field ID is 36.


Verify before sending

Before sending the credentials, confirm the following:

  1. All three tokens captured. You have the Access token, the ID token, and the Refresh token, all from the same token creation flow. Gecko displays each one only once upon creation. If you missed any, the simplest fix is to delete the token from Active Sessions and regenerate it.

  2. Tokens created from the API user's session. You were logged in as the dedicated API user (not your admin account) when you clicked "Create New API Token". If you were logged in as someone else, the tokens belong to that user; delete them and regenerate from the correct session.

  3. Region confirmed. You can tell us which Gecko region your instance is in: EU (geckoengage.com) or US (geckoengage.us). The wrong region will cause authentication failures.

  4. Field IDs table provided. For each field listed in the Field mapping section below, you have the numeric Field ID from your Gecko tenant for both built-in fields and custom attributes. Without complete Field IDs, we cannot configure the mapping.

  5. Channel. Generate a one-time encrypted link using our secrets page with all three tokens and the region, then email the link to your Uni Compare contact. The Field IDs table can come via the support chat (it's mapping metadata, not credentials).

Important: Never paste credentials into a web chat, plain email, or any unencrypted attachment.


Field mapping

We create Contact records deduplicated by email. If a contact with the same email already exists, we update it; otherwise we create a new one.

Gecko identifies Contact fields by numeric Field ID rather than by name, so each Uni Compare field is written to the Field ID you nominate at onboarding (see Step 5).

The fields below show what we send:

  • First name and last name → Gecko Field IDs you nominate

  • Email → Gecko Field ID you nominate

  • Phone (where given) → Gecko Field ID you nominate

  • Postcode → Gecko Field ID you nominate

  • Address (where given) → Gecko Field ID you nominate

  • Study Level (undergraduate or postgraduate) → Gecko Field ID you nominate

  • Start Year → Gecko Field ID you nominate

  • Subject Area (where given) → Gecko Field ID you nominate

  • Free-text enquiry message (where given) → Gecko Field ID you nominate

  • Lead type → Gecko Field ID you nominate

  • Marketing consent flag → Gecko Field ID you nominate (boolean field)

  • Uni Compare lead identifier → Gecko Field ID you nominate (for traceability)

Frequently asked questions

Why three tokens? What does each do?

Gecko issues three JWTs when you create an API token: the Access token is short-lived and used to authenticate API calls; the Refresh token is long-lived and used to obtain new Access tokens when the current one expires; the ID token identifies the user the API call is being made on behalf of. Our integration uses the Refresh token to rotate Access tokens automatically; you don't need to do anything once we have all three.

How is the Refresh token rotated or revoked?

Gecko's Refresh tokens are long-lived but can be revoked from Active Sessions at any time. We use the Refresh token to obtain new short-lived Access tokens automatically. If you revoke the Refresh token, the integration stops; tell us before you do this so we can plan a rotation.

Gecko already pushes our leads to our CRM. What should we do?

Two options. Option one: Uni Compare delivers to Gecko, Gecko's existing onward webhook takes the leads from there to your CRM (lower risk of duplication, but a longer chain). Option two: Uni Compare delivers directly to your CRM, bypassing Gecko (more direct but requires you to provide credentials for the destination CRM and to confirm Gecko is not also pushing the same prospect). Discuss with us via the support chat. The right answer depends on whether your existing Gecko-to-CRM rules need to apply to Uni Compare leads as well.

Do we need a sandbox for the pre-go-live test?

GeckoEngage does not offer a separate sandbox tenant on most plans. We instead use a clearly-marked test campaign or a list in your production instance, with synthetic contacts you delete after the test.

Useful links

  • GeckoEngage website — the official product website, including contact details for sales and support.

  • GeckoEngage Help Center — Gecko's knowledge base, including guides on user permissions, API tokens, and custom attributes.

  • GeckoEngage Developer Portal — Gecko's API reference, useful if your security team wants to understand what endpoints our integration calls.

Did this answer your question?