¶ FsHub Webhooks Documentation
Webhooks can be setup on FsHub user accounts in addition to airline groups and is a great way of "pushing" data (using HTTP POST requests) to external websites and services in real-time when an action occurs on your account or for a virtual airline pilot's account.
FsHub has several webhook events that you can set-up on your account or for virtual airlines, this page details information about this feature.
¶ Create a webhook...
¶ ...for your personal account
Go to your Account Settings and head over to the Integrations page.
Inside this area you can create or view your webhooks.
You can create a webhook by clicking the Add a webhook button.
You will need to enter the following details for your webhook:
- Endpoint: The URL that the webhook will send a POST request to
- Enabled?: Allows you to 'pause' sending webhooks without deleting the webhook
- Events: Select which events should 'fire' the webhook
¶ ...for your Virtual Airline
Go to the Integrations area of the VA Crew Portal
You can create a webhook by clicking the Add a webhook button.
- Name: Name your Webhook, this is useful when using multiple hooks for different purposes.
- Endpoint: The URL that the webhook will send a POST request to
- Discord Server? Select this, if you are not developing an own application. This checkbox makes sure, that your Webhook is formatted for Discord
If you want more sofisticated alerts and messages, we can recommend the third party service FsHub2Discord.
- Enabled?: Allows you to 'pause' sending webhooks without deleting the webhook
- Events: Select which events should 'fire' the webhook
¶ Webhooks disabling?
In the event FsHub can not fire the webhook (after 10 tries over 40 minutes) or your webserver does not provide a response, FsHub will disable the webhook automatically to prevent futher issues.
Verify your webserver is online, accepts requests and has at least a simple HTTP 200 response. If you are using a third party integration, please contact the developer of that integration as it is out of FsHub's control.
You will also receive an e-mail notification when a webhook in your account or VA gets disabled!
¶ Webhook events
Depending on your web server's configuration and/or if you are using a web application framework, the CSRF protection settings, may prevent these web hooks from being successfully received by your web application/scripts. You can find out more and what you might need to tweak in order for our webhooks to be successfully delivered to your website and applications on our Optimal Server Settings for webhooks page.
We are still populating this article. In the meantime, you can find all webhook event documentation here.