Set up your Custom Ticket Sidebar

What is a custom ticket sidebar?

The custom sidebar will display additional information from your own app within tickets.

Set up your Endpoint

1. You need to set up an endpoint in your application that accepts a POST request and returns a JSON with either one key named html and raw (escaped) HTML as the value, or you can just pass a JSON with your data, and we parse it automatically. Learn more about it here or just use the Laravel HelpSpace Package if you are running on Laravel.

2. Every POST request contains a JSON with the details of the ticket. You can see the request payload here.

Enable your Custom Sidebar

1. Go to Settings → Integrations and click on "Manage Sidebar"

2. Enter your Endpoint URL where you want to get the data from.

3. Click on "Save"

Integrate Using a Laravel Package

You are using Laravel and want to add the sidebar endpoint to your app? No problem!
Freek Van der Herten has written a great Laravel Package to have the endpoint ready in no time:

https://github.com/spatie/laravel-help-space

He also wrote an article about the package on bis personal blog where he dives a bit deeper into the code:

https://freek.dev/2404-a-package-to-integrate-helpspace-in-your-laravel-app

A big thank you to Freek and his Team at Spatie for maintaining a package that HelpSpace users will surely enjoy using!