Skip to main content
Webhooks allow you to communicate with third-party applications or your own apps and systems by sending HTTP POST requests when specific events occur in Firmhouse. You can view all available webhook events in the developer documentation.

​
Setting up webhooks in Firmhouse

Creating a webhook in Firmhouse is a simple three-step process:
  1. Get the webhook URL from the application you want the data sent to
  2. Use that URL in the webhook section in Firmhouse
  3. Set up what events you want your webhook to listen to and notify you about when it occurs

​
Create a webhook in Firmhouse

​
Steps

  1. Navigate to Apps in the sidebar
  2. Find the Webhooks app and click Configure
  3. Click New outgoing webhook on the top-right
  4. Enter a Name for the webhook, such as “Activated subscription”
  5. In the Endpoint url field, enter the URL you want to receive the webhook. This is where the data will be sent once the webhook is triggered. The URL will receive an HTTP POST request when the selected event happens.
  6. If you intend to use Basic authentication to secure your webhook, provide the Username and Password of the HTTP Basic auth, otherwise leave Authentication type on None
  7. From the Event dropdown, select the event you want to be notified about (e.g., Subscription activated)
  8. In the Template field, configure your payload using JSON format and Liquid tags. For example: 
    {
  "event": "subscription activated",
  "id": {{subscription.id}}
}
    Learn more about Liquid tags in Firmhouse in the developer documentation.
  9. Click Save to save the outgoing webhook
Webhook Configuration Form

​
Enable or disable a webhook

You can enable or disable your outgoing webhook temporarily without having to delete the webhook itself or its content.

​
Steps

  1. Navigate to Apps in the sidebar
  2. Find the Webhooks app and click Configure to open a list of already saved outgoing webhooks
  3. Click on the particular webhook you want to enable/disable and click Edit
  4. To enable or disable the webhook, check or uncheck the Enable checkbox, respectively
  5. Click Save to save the outgoing webhook

​
Editing a webhook

Firmhouse allows you to edit the configuration of your webhooks.

​
Steps

  1. Navigate to Apps in the sidebar
  2. Find the Webhooks app and click Configure to display a list of already saved outgoing webhooks
  3. Click on the webhook that you want to edit and click on the Edit button
  4. Make the necessary changes to the configuration fields of the webhook
  5. Click Save to save the changes

​
Deleting a webhook

Firmhouse allows you to delete webhooks you no longer need.

​
Steps

  1. Navigate to Apps in the sidebar
  2. Find the Webhooks app and click Configure to display a list of already saved outgoing webhooks
  3. Click on the Remove button on the far right of the webhook that you want to delete
  4. You will get a prompt “Are you sure you want to remove this outgoing webhook?”, click Ok to confirm the delete action
Webhooks List with Remove Button