Build a connector
A data connector pulls information from your own shop, CRM or API and shows it to your team, right on the ticket — no code. You build one in a short guided flow: name it, tell Clarify how to sign in, define a request, run a test call, then click the response fields you want to show. This page walks through every step.
Build a connector step by step
Basics
Give your connector its identity. These settings decide how it looks in the dashboard and on the ticket.
https://api.myshop.com. Must start with https:// — Clarify only talks to public, secure endpoints. You add the specific path for each request in a later step.Authentication
Tell Clarify how to sign in to your API. Pick the one type your provider uses — the fields change to match it. Whatever you enter here is encrypted before it's stored and is never shown back to you in full.
X-API-Key or api_key) and the value (your key). The value is encrypted.Authorization header as Bearer <token>. Paste the token — it's encrypted at rest.https://api.clarify.bot/connectors/oauth/callback
First operation
Define the request Clarify will send to fetch data.
GET, POST, PUT, PATCH or DELETE. Most lookups are GET./customers/{id}. Together they form the full request URL./customers/{email} — and Clarify fills it in from the ticket or from Discord auto-detect each time.Test call
Run the request straight from the builder. Clarify sends a real call to your API and shows you the live JSON response it gets back. This confirms your base URL, authentication and path all work before you go further — and it gives you the actual field names to map in the next step.
Map fields
Turn the response into something your team can read. In the live JSON from your test call, click the fields you want to show — each one becomes a %placeholder% token you can drop into the ticket card. For example, a status field becomes %status% and total becomes %total%.
Those placeholders fill the connector's card, so when the connector runs on a ticket, your team sees the real values in a clean card instead of raw JSON.
Make it usable
Decide when and where the connector runs.
You link a connector to a category on the Categories page under Connector Bindings.
Managing a connector
Once a connector is saved, these controls keep it healthy and organised.
Your credentials stay private
Every key, token and password you enter — API keys, bearer tokens, Basic passwords, OAuth client secrets and the tokens Clarify mints for you — is encrypted before it's stored and never shown back to you in full. When you edit a connector, secret fields appear blank; leave them blank to keep the stored value.