Configure outgoing webhooks

​

Setting up webhooks in Firmhouse

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

​

Enable or disable a webhook

​

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

​

Subscription discount webhook events

• subscription_discount_applied: sent when a discount is first applied to a completed subscription.
• subscription_discount_updated: sent when an applied discount changes, including usage updates and deactivation (active = false).
• subscription_discount_deleted: sent when an applied discount is removed, including Shopify discount removals from the Applied discounts section.

{
  "event": "{{event}}",
  "subscription_id": {{subscription.id}}
}

​

Order scheduled webhook event

{
  "event": "{{event}}",
  "order_id": {{order.id}},
  "shipment_date": "{{order.shipment_date}}",
  "subscription_id": {{subscription.id}}
}

​

Subscription upcoming billing webhook event

• This event is available only for order-based projects with plan management enabled.
• Firmhouse evaluates eligible subscriptions every night at 01:00.
• You can configure how many days before subscribed_plan.next_billing_date this event should fire in the webhook settings (1-5 days, default: 1 day).
• By default, this webhook is also sent for paused subscriptions so you can remind your customers to resume their subscription when their planned order date is approaching. You can also turn off Also send while subscription is paused in the webhook settings if paused subscriptions should be fully skipped.
• By default, subscriptions marked as non-paying are skipped. Turn on Also send while subscription is marked as non-paying if you still want this webhook for subscriptions with unresolved payment issues.

​

Upcoming order notice webhook event

​

GraphQL bulk operation finished webhook event

​

Editing a webhook

​

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

​

Send a test event

​

Enable in New Features

​

Steps

1. Navigate to Apps in the sidebar.
2. Find the Webhooks app and click Configure.
3. Open an existing outgoing webhook.
4. Review or update the webhook template.
5. Click Save if you made any changes.
6. Click Send test event.
7. Check the Webhook event log for the request body, response code, response body, duration, and attempt count.

​

Deleting a webhook

​

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