⌘ K

Search

Search portal content

AI customer support in one tabAI customer support in one tab
⌘ K

Search

Search portal content

AI customer support in one tabAI customer support in one tab
  • Connect Slack
  • Use initdesk in ChatGPT
  • Use initdesk in Grok Bot
  • Use initdesk in Claude
  • Connect Linear
  • Connect Jira
  • Bring your own data
  • Connect AbacatePay
  • Connect Nomus
  1. Home
  2. Plugins

Bring your own data

Bring Your Own Data calls your own API with the customer's email and shows what it returns in the ticket sidebar, with no sync or import.

Bring your own data

Bring Your Own Data calls your own API with the customer's email and shows what it returns in the ticket sidebar, with no sync or import.

Bring Your Own Data (BYOD) shows information from your own systems next to each ticket. You give initdesk the address of an API you control. When someone opens a ticket, initdesk sends that API the customer's email, and shows the answer in the ticket sidebar. You see the customer's plan, last invoice, or account status without leaving the ticket.

Before you start

  • You need to be an owner or admin of your initdesk organization.
  • You need an API endpoint you control that accepts a POST and answers with a JSON object. It must be reachable from the internet. Addresses that point to private or local networks are blocked.
  • Your API needs to look customers up by email.

Set up Bring Your Own Data

  1. Go to Settings > Bring Your Own Data.
  2. Under Data source, enter the Endpoint, for example https://api.example.com/customers.
  3. Optional: open Request details to set the request headers, a timeout, and a signing key (see below).
  4. Under Panel, write the Template that turns your API's answer into what agents see.
  5. Optional: set a Heading and Subheading for the panel.
  6. Select Save changes.
The Bring Your Own Data settings with the endpoint, request details, and the test area
Set the endpoint and the template, then run a test.

Request details

  • Request headers: select Add header to send a name and value with every call, such as an API key or tenant ID. You can add up to 20. A few headers can't be used, such as Host, Cookie, and Content-Length.
  • Give up after: how long initdesk waits for your API, from 1 to 10 seconds. If your API takes longer, agents see the ticket without the panel.
  • Signing key: an optional secret. initdesk sends it as the X-Initdesk-Key header on every request. Compare it in your API to confirm the call came from initdesk.

Show or hide the panel

The Show in ticket sidebar switch turns the panel on or off without removing your setup.

What your API receives

initdesk sends an HTTP POST with a JSON body and these headers: Content-Type: application/json, Accept: application/json, your own headers, and X-Initdesk-Key if you set a signing key.

1
2
3
4
5{
  "email": "customer@example.com",
  "ticket_id": 123,
  "subject": "Where is my invoice?"
}
Field What it is
email The requester's email address.
ticket_id The ticket number.
subject The ticket subject.

In a test run without ticket details, ticket_id can be 0 and subject can be empty.

What your API must return

Return a JSON object, with a success status code.

1
2
3
4
5
6
7
8{
  "customer": {
    "name": "Ana Rivera",
    "plan": "Pro",
    "status": "active",
    "renewal_date": "2026-09-12"
  }
}

These cause an error instead of a panel:

  • An answer that isn't a JSON object, such as a list.
  • An HTTP status of 400 or higher.
  • A redirect. initdesk doesn't follow them.
  • An answer larger than 256 KiB.
  • An answer slower than your timeout.

Write the template

The template uses Liquid, a simple templating language, to turn the JSON into HTML. Three things are available:

Variable What it holds
data Your API's answer. For the example above, data.customer.plan is Pro.
customer.email The requester's email.
ticket.id and ticket.subject The ticket number and subject.
1
2
3
4
5
6
7
8
9
10<dl>
  <dt>Customer</dt>
  <dd>{{ data.customer.name }}</dd>
  <dt>Plan</dt>
  <dd>{{ data.customer.plan }}</dd>
  <dt>Status</dt>
  <dd>{{ data.customer.status }}</dd>
  <dt>Renewal date</dt>
  <dd>{{ data.customer.renewal_date }}</dd>
</dl>

Use the Snippets next to the editor to insert a Value, Choice (a condition), or Repeat (a loop), and ready-made blocks such as Pairs, List, Table, Badge, and Button. The template can be up to 20,000 characters.

initdesk cleans the HTML before showing it. Scripts, event handlers, and styles don't run. Links work for http, https, and mailto addresses.

Test before you save

  1. In the test panel, enter an email under Test with.
  2. Optional: turn on Send ticket details too and enter a Ticket ID and Subject.
  3. Select Run test, then confirm Run connection test?.

The test sends a real request to your endpoint using the current draft. It doesn't save or activate anything. The Panel tab shows what an agent would see, and the Response tab shows what your API sent back, with a Copy response button.

What agents see

When the panel is on, the ticket sidebar shows a section named after your Heading. With no heading, it's named BYOD. It shows your template's output in full, with no need to expand it.

The ticket sidebar with a customer data panel
Your data appears beside the ticket.

If your API fails, the section says "Customer data is unavailable" and offers Retry. The rest of the ticket works normally.

Remove the connection

At the bottom of the page, select Remove connection and confirm Remove Bring Your Own Data?. The endpoint, headers, signing key, and template are deleted, and agents stop seeing the panel right away.

If something's not working

If you see "Your endpoint took longer than the timeout. Raise the timeout or check the endpoint."

Raise Give up after (up to 10 seconds), or make your API faster.

If you see "Your endpoint returned nothing for this customer. Try another email."

Your API answered, but with nothing for that email. Test with an email you know exists.

If you see "Your endpoint answered, but initdesk couldn't build a panel from it. Check the endpoint and the template."

Check that the response is a JSON object, and that the names in your template match it under data. Start with a very simple template.

If the test works but the panel is empty on a ticket

Check that Show in ticket sidebar is on and that your API finds the real requester's email.

Related

  • Handle sensitive requests
  • Manage customers
  • Connect Slack
Connect Jira

Create a Jira issue or link an existing one from a ticket, see its status beside the conversation, and get the ticket back when it's done.

Connect AbacatePay

Connect AbacatePay with an API key and see the requester's customer record, checkouts, and subscriptions in the ticket sidebar.

Powered by initdesk
On this page
  • Bring your own data
  • Before you start
  • Set up Bring Your Own Data
  • Request details
  • Show or hide the panel
  • What your API receives
  • What your API must return
  • Write the template
  • Test before you save
  • What agents see
  • Remove the connection
  • If something's not working
  • If you see "Your endpoint took longer than the timeout. Raise the timeout or check the endpoint."
  • If you see "Your endpoint returned nothing for this customer. Try another email."
  • If you see "Your endpoint answered, but initdesk couldn't build a panel from it. Check the endpoint and the template."
  • If the test works but the panel is empty on a ticket
  • Related