What are webhooks?
A webhook is an automatic message Dockwa sends to a web address (URL) you control whenever something happens in your marina's account, such as a new reservation, an updated customer, or a completed sale. Instead of your team or another system checking Dockwa for changes, Dockwa sends the data as soon as it happens.
Webhooks are used to keep an accounting system, CRM, property management system, or internal tool in sync with Dockwa without manual exports or double entry.
Before you begin
You'll need a URL that can receive and process the data Dockwa sends. That's usually a server, an integration platform such as Zapier or Make, or an app built by you or a technical partner. Dockwa handles everything on the marina side, covered below. Building the receiving endpoint happens outside Dockwa.
Webhooks turned on for your marina. They aren't on by default: Dockwa turns them on for each type of record. If you don't see a Webhooks tab in Settings, contact Dockwa Support.
A Dockwa user with the Admin role. If your marina belongs to a group that shares one webhooks dashboard, a Group Admin manages it instead.
An HTTPS URL that can receive POST requests (your endpoint). Your developer, integration platform, or software vendor usually provides this.
An idea of which events you want to receive. You can pick specific events or receive all of them.
Open the Webhooks dashboard
Go to Account > Settings.
Select the Webhooks tab.
The Webhooks dashboard has four tabs:
Endpoints: add, view, and manage the URLs Dockwa sends data to.
Event Catalog: every event you can subscribe to, with sample data.
Logs: a record of every delivery attempt, for troubleshooting.
Activity: a feed of recent webhook activity across your endpoints.
In the top-right corner, Need Help? View Documentation opens Svix's general guide to receiving webhooks, including how to verify incoming requests.
Open Dashboard in New Tab opens the dashboard in its own tab so you can keep it open while you set up your endpoint elsewhere.
Review the available events
Select the Event Catalog tab to see what data is available. Dockwa offers up to 12 events across 6 types of records. The Event Catalog shows only the record types turned on for your marina. Each record type has a created event (a new record) and an updated event (a change to an existing record).
Record | Events | What it represents |
Customer | customer.created, customer.updated | A boater's customer profile at your marina: contact information, address, and Safe Harbor membership |
Lead | lead.created, lead.updated | An inquiry from a boater requesting a service, such as long-term or dry storage, and its status as your team works it |
Reservation | reservation.created, reservation.updated | A booking at your marina (transient, contract, or month-to-month contract), including dockage, charges, and payments |
Sale | sale.created, sale.updated | A point-of-sale transaction, such as fuel, ship store items, or other retail charges |
Space | space.created, space.updated | An individual slip, mooring, dock space, or storage space |
Space Group | space_group.created, space_group.updated | A named group of spaces, such as a dock or storage area, with shared booking rules |
Looking for contracts? Contracts don't have their own events. Once a contract is signed, it becomes a reservation with a reservation_type of contract or month_to_month_contract (transient bookings are transient). Subscribing to the reservation events covers contracts too.
Click the info icon next to any event to see its full field list and a sample payload.
Add an endpoint
On the Endpoints tab, click + Add Endpoint.
Enter the Endpoint URL, the full HTTPS address that will receive the data (for example, https://www.example.com/webhook). If your endpoint isn't ready yet, click with Svix Play below the field to create a temporary URL where you can see test deliveries.
Optionally, add a Description so your team can recognize the endpoint later (for example, "Front desk CRM").
Under Subscribe to events, choose the events this endpoint should receive. Check a record type to select both its created and updated events, or check individual events. You can also search for an event by name. If you leave every box unchecked, the endpoint receives all events, and the form shows "Receiving all events."
Optionally, expand Advanced Configuration for settings such as custom HTTP headers.
Click Create. The endpoint starts receiving the events you selected right away.
Tip: You can add more than one endpoint, each with its own events. For example, send reservation events to your property management system and sale events to your accounting system.
Manage and monitor endpoints
The Endpoints tab lists each endpoint with its Error Rate, so you can see at a glance whether deliveries are succeeding.
View or edit an endpoint: click it to update the URL, description, or events, or to copy its signing secret.
Check deliveries: the Logs tab shows each delivery attempt with its response status and timing. Start here if a system isn't receiving data.
See recent activity: the Activity tab shows a running feed for your account.
Pause or delete an endpoint: open the endpoint to disable it temporarily or delete it.
Security best practices
Always use an HTTPS URL so data is encrypted in transit.
Verify each incoming request with your endpoint's signing secret before acting on it. This confirms the request came from Dockwa.
Subscribe only to the events you need.
Check the Logs and Activity tabs regularly, especially after changes to your receiving system.
Getting help
For field-level details and sample payloads, open the Event Catalog tab in the Webhooks dashboard. If you run into a problem, contact Dockwa Support and include the error details from the endpoint's Logs tab.