Webhook API

Webhook API's can be used to easily trigger certain actions on your domain. For example, if you have a mod where you want to wipe the server at a specific moment (webhook trigger), you can do so using the available webhooks listed below.

If you are looking for a certain action, but are not sure if there is a webhook available, please reach out to us!

Webhook API authentication

Please never share your API credentials with ANYONE.
Issues resulting in unauthorised usage because of this are not our responsibility.

You can find your Webhook API keys here: https://dash.gameserverapp.com/community/api

All Webhook API requests should have (without the {}):

  1. a ?client_id={CLIENT ID HERE} http query parameter added to the url
  2. a {WEBHOOK SECRET HERE} in the body/content of your request

Without these auth-credentials you will receive a 401 / Unauthorised error response.
Please also make sure to send the right request type: POST or GET. 

Example request:
In this example you see that the Gameserver ID is required. You can find the Gameserver ID for your gameserver below the controls (start/stop) with your gameserver settings.

POST https://api.gameserverapp.com/api/v1/server/{gameserver ID}/wipe?client_id=kmhsnkgsvkgndjgkkjghdkdkgnyeigyimyfimgyqiq3q3awsa
Request body LUh1bYG0aBvcVClIKb30Trewe7yIC5ARy5fE2J


Available webhook endpoints

Start gameserver
This request will queue your gameserver to start as soon as possible.

POST https://api.gameserverapp.com/api/v1/server/{gameserver ID}/start?client_id={clientID}


Stop gameserver
This request will queue your gameserver to stop as soon as possible.

POST https://api.gameserverapp.com/api/v1/server/{gameserver ID}/stop?client_id={clientID}


Restart gameserver
This request will queue your gameserver to restart as soon as possible.

POST https://api.gameserverapp.com/api/v1/server/{gameserver ID}/restart?client_id={clientID}


Update gameserver
This request will schedule your gameserver to update with a 30 minute countdown. You can add a &countdown=10 at the end to set a custom countdown timer, in minutes.

POST https://api.gameserverapp.com/api/v1/server/{gameserver ID}/update?client_id={clientID}


Wipe gameserver
This request will queue your gameserver to wipe as soon as possible.

POST https://api.gameserverapp.com/api/v1/server/{gameserver ID}/wipe?client_id={clientID}


Cancel schedule actions gameserver
This request will cancel all scheduled actions, if the gameserver is not yet locked.

POST https://api.gameserverapp.com/api/v1/server/{gameserver ID}/cancel-scheduled?client_id={clientID}

Still need help? Contact Us Contact Us