Skip to main content

Webhooks Setup Growth+This feature requires the Growth+ plan or higher

Webhooks let external applications receive real-time notifications when something happens in your EquipDash account. Instead of repeatedly polling the API, your application gets an instant HTTP POST request every time a selected event occurs.


Creating a Webhook Endpointโ€‹

  1. Click Settings in the sidebar.
  2. Select API & Integrations from the settings menu.
  3. Click the Webhooks tab.
  4. Click + Create webhook.
  5. Fill in the following:
    • Name -- a descriptive label (e.g., "Accounting Sync", "Slack Notifications").
    • URL -- the endpoint URL where EquipDash should send the webhook payloads (must be HTTPS).
    • Events -- select which events should trigger this webhook (see the events table below).
    • Active -- toggle on to start receiving events immediately.
  6. Click Create.

The Webhooks tab on the API & Integrations settings page


Webhook Secretโ€‹

After creating a webhook, EquipDash generates a webhook secret. This secret is used to verify that incoming requests genuinely came from EquipDash.

  1. Copy the secret immediately and store it securely.
  2. Use the secret to validate the X-Webhook-Signature header on incoming requests.
caution

The webhook secret is shown only once when the webhook is created. If you lose it, you can regenerate it from the webhook detail page -- but your application will need to be updated with the new secret.


Available Webhook Eventsโ€‹

Bookingsโ€‹

EventTriggered when
booking.createdA new booking is created
booking.updatedA booking is modified
booking.cancelledA booking is cancelled
booking.completedA booking is marked as completed

Paymentsโ€‹

EventTriggered when
payment.receivedA payment is recorded
payment.refundedA refund is processed

Customersโ€‹

EventTriggered when
customer.createdA new customer is added
customer.updatedA customer record is modified
customer.deletedA customer is deleted

Productsโ€‹

EventTriggered when
product.createdA new product is added
product.updatedA product is modified
product.archivedA product is archived

Experiencesโ€‹

EventTriggered when
experience.createdA new experience is added
experience.updatedAn experience is modified
experience.archivedAn experience is archived

Formsโ€‹

EventTriggered when
form_response.submittedA customer submits a waiver or form

Vouchersโ€‹

EventTriggered when
voucher.soldA voucher or gift card is purchased
voucher.redeemedA voucher is used on a booking

Managing Webhooksโ€‹

From the Webhooks tab, you can:

  • Edit a webhook to change its name, URL, or selected events.
  • Pause a webhook by toggling it to inactive. Events will not be sent while paused.
  • Regenerate Secret if your webhook secret has been compromised.
  • Delete a webhook to remove it permanently.

Verifying Webhook Signaturesโ€‹

Every webhook request includes an X-Webhook-Signature header. To verify the request is genuine:

  1. Compute an HMAC-SHA256 hash of the request body using your webhook secret.
  2. Compare the computed hash with the value in the X-Webhook-Signature header.
  3. If they match, the request is authentic.

This prevents attackers from sending fake webhook events to your endpoint.