Setting Up Your Custom Profile App

To start playing around with the Custom Profile app, head over to the Apps tab in your account: 

Once installed, you can begin to configure your custom profile by going into the Settings.

The Custom Profile App requires four things to function properly:

  1. An HTTP/HTTPS endpoint URL on your server that the Groove servers can call.
  2. The endpoint must return valid JSON.
  3. Your JSON keys may not include any spaces.
  4. An HTML template to display next to every ticket.

After installing you'll need to tell us exactly what you want us to display and how you want it to look: 

Headline

Allows you to customize the text above your Custom Profile. 

HTML Template

This is where things start to get fun.  After we've fetched custom attributes from your Webhook, you can render them directly on the template page using a Liquid template. To insert an attribute into your html simple wrap in double curly brackets like so:

"Name: {{preferred_name}}"

Inserting variables is just the beginning though. We highly recommend checking out the Liquid docs. Especially using if statements around custom attributes that aren't available for all customers and filters to format text. Have a look at part of the template we use in our Groove account to see what's possible:

Webhook URL

We'll fetch your custom attributes from your server using this URL after every new message from your customers.  We will use a GET request with email and api_token parameters. You should check the given api_token matches the one from your account, and return non-nested JSON for the given email address. 

Testing

Prior to saving you should provide a real customer's email adress and test that your Webhook and Custom Profile are working as expected. We will fetch the details from your server and render an example.

 

End Result

Once everyting looks the way you want and is saved, all new tickets will include your Custom Profile on the right side of the screen.

JSON Examples

JSON should be returned as a single level hash.  This is correct:

Nested keys will not work. This example is incorrect: