Developer

The Developer page is where you create the API keys that let other software read or change your Yapii data.

Owners and admins

Open Settings, then Advanced, under Rarely needed, and choose the Developer tab.

Most people never need this page. It's here for when you or someone on your team is connecting Yapii to something that isn't already on the Integrations page.

Once you have a key, The Yapii API summarizes what it can reach.

What a key is

A key is a long secret string. Software that has it can act on your workspace, so treat it exactly like a password. Keys only ever reach your own workspace's data, never anyone else's.

Creating a key

1. Give the key a name that says what it's for, such as "Zapier integration". A year from now this is the only clue you'll have about what a key does.
2. Under What can this key do?, choose its access:
   • Full access reads and changes everything in the workspace;
   • Read only sees everything and changes nothing;
   • Leads in only can send in new leads and cannot read any contact;
   • Acts as one agent sees and changes only what the agent you choose can. You pick the agent in the Agent box.
3. Choose when it expires: Never expires, 30 days, 90 days, 1 year, or a date you pick.
4. Create it.

You see the key once

The full key is shown only at the moment you create it. Yapii stores the first few characters so you can tell your keys apart, but it never keeps the rest and can't show it to you again. Copy it somewhere safe straight away. If you lose it, delete the key and make a new one.

Choosing an access level

Pick Read only whenever the other software only needs to look at things, such as a reporting dashboard. A read-only key that leaks is a much smaller problem than one that can change or delete your contacts.

Managing your keys

The table lists every key with its Name, Token (the stored first characters), Access, Expires, Last used and Created.

The "last used" column is the one to check. A key nothing has used for months is usually a key you can delete.

Delete a key the moment it's no longer needed, or if you think anyone else has seen it. Deleting takes effect immediately, so anything still using that key stops working.

Connecting an AI app

Settings, AI Features, then the AI connection tab, is where you connect an AI app such as Claude or ChatGPT to your workspace. Once connected, the AI can look things up and make changes in this workspace the way you do in Yapii. It only ever sees this workspace. The page walks you through it.

1. Copy the address. The Connect your AI to this workspace card shows your workspace's address, with a Copy address button. Any AI app that supports MCP connections can use it.

2. Choose what the AI may do. There are three levels, and the level is set on the key, so to change it you make a new key and remove the old one:

   • Look only reads contacts, calls, reports and settings and changes nothing. It is the Read only key setting.
   • Look and edit also adds notes, tasks and tags and updates records. Anything that texts, calls or emails a person, or removes records, waits for your yes. It is the Full access key setting.
   • Acts as a team member sees exactly what one team member sees and nothing more. It is the Acts as one agent key setting.

   Create a key takes you to the Developer tab, where the key is shown once. A person always has to do billing and plan changes, creating or removing API keys, deleting the workspace and privacy requests. An AI never does.

3. Add it to your AI app. Pick Claude, ChatGPT or Other apps for the steps. In the app you add a custom connector, paste the address, press Connect, sign in to Yapii if asked, choose what it may do and press Allow. If the app would rather use a key, make one in step 2 and send it as a Bearer key in the Authorization header. A connection made with the sign-in button shows up on the Developer tab as a key named "(one-click)". Remove that key to disconnect the app.

4. Check it. Ask the app "What can you do in Yapii?" and it lists the areas it can work in.

Three cards below the steps keep it under control. Owners and admins use them:

• Pause AI changes is one switch. It reads AI changes are on or AI changes are paused. While paused, every connected AI is read only: it can still look things up but cannot add, edit, send or remove anything.
• Instructions for your AI is a note, up to 4,000 characters, that every connected AI reads when it connects. Use it for how to address leads, hours to avoid or who you are, then press Save instructions. It cannot turn off the approval step or the pause switch.
• Recent AI changes lists what your connected AI changed, newest first, with When, What, Where, Your OK (Approved or Not needed), Result and Undo. Looking things up is not listed. Undo puts an edited record back the way it was. If someone edited it since, the row says Changed since and offers Undo anyway. Sends, deletes and new records cannot be undone. Anyone else who opens the tab sees that only an owner or admin can see the list.

Website tracking

Settings, Advanced, then the Website tracking tab, is where an owner or admin can see which pages of your website or IDX site a contact visited. Everyone else sees a line saying only an owner or admin can see the page.

1. Confirm your privacy policy. Tick the box that says your website's privacy policy tells visitors you track page views and may link them to their contact record. Yapii keeps who confirmed it, and when.
2. Turn it on. The switch reads Website tracking is off until you do, and Website tracking is on after. Nothing is recorded while it is off, even if the snippet is already on your site.
3. Add the snippet. The Add this to your website card holds a small piece of code. Press Copy snippet and paste it into your site.

A visit starts out anonymous. It is only tied to a contact when the visitor arrives through a link from Yapii that names them, or sends your lead-capture form and becomes a new contact. Then their earlier visits from the same browser are added to that contact. Yapii stores the page address without anything after a question mark. The page also gives wording you can add to your site's privacy policy.

Lead-capture form

Under the tracking card, the Lead-capture form card gives you a ready-made contact form to put on your website. It is off until you turn it on: the switch reads Lead-capture form is off and then Lead-capture form is on. Press Copy snippet and paste it into your site, in the same way as the tracking snippet. Nothing is accepted while the switch is off, even if the form is already on your site.

The form asks for a name, email, phone and a message. A visitor has to give a usable email or a phone number, or the form asks them to try again.

• Someone new becomes a contact, tagged site-form-lead and routed like any other new lead. Their earlier page views from the same browser are added to that contact.
• Someone you already have (matched by email, then phone) is not changed. What they typed is added to their timeline as a line that starts with "Website form submitted - not applied to this contact, review before using", so you can decide what to do with it.

Webhooks

API keys are for software that asks Yapii for something. Webhooks are the other direction: Yapii tells your systems when something happens, and lead sources can send new leads in. Both are set up under Integrations.

Good to know

• Don't paste a key into a shared document, a chat message or anything a client could see.
• Give each tool its own key. Then you can turn one off without breaking the others.
• Set an expiry where you can. A key that expires is one less thing to remember to clean up.