Workspaces

Workspaces

A workspace is a home for your team's connections, routing logic, and event history. Users must be a member of at least one workspace in order to use Hookdeck.

Billing occurs on a per-workspace basis, so each workspace can have its own distinct plan depending on its needs.

Workspace settings

API key

You will need this value to query Hookdeck's API. Find it on the Secrets tab in your workspace settings.

To reset your API key, click the Roll Key button.

Signing secret

The signing secret can be found on the Secrets tab in your workspace settings. Your destination server should use this value to verify the authenticity of requests coming from Hookdeck. Find the details on how to verify Hookdeck's signature here.

To reset your signing secret, click the Roll Key button.

Members

The Members tab in your workspace settings displays all the users who have access to your workspace's connections, event history, issues, and more. Add or remove members to manage their access.

Quotas

The Quotas tab in your workspace settings reports your current plan's ceilings, including its maximum throughput rates, total request limit, maximum payload size, delivery timeout, and more. Some of these values can be increased by upgrading your plan, or by contacting us directly.

The request rate and attempt rate are soft ceilings. No requests are ever discarded, even when these rates are exceeded. Rather, a leaky bucket algorithm is employed to process requests up to the listed rates, and retain the rest for processing at the next available moment. Plans with greater throughput can process requests and events at a higher maximum rate.

Custom domain

You can set a custom domain for your workspace which will be used to generate your HTTP URLs. This is useful if you want to customize the URLs you share with your customers or embed into your clients that generate events.

To set a custom domain, see the Custom domain section of the general workspace settings.

For the SSL certification to be provisioned your DNS config must authorize the following Certification Authorities through CAA records. For most DNS provider they will be configured by default.

example.com. IN CAA 0 issue "digicert.com"
example.com. IN CAA 0 issue "letsencrypt.org"
example.com. IN CAA 0 issue "pki.goog"

See this article for CAA records requirements.

Delivery with static IPs

If you need inbound events to arrive from a predictable set of IP addresses, contact us to request the static IP add-on for your workspace.

To check whether the static IP add-on is enabled, see the Delivery section under your general workspace settings. If enabled, Hookdeck requests will arrive from one of the following IP addresses:

  • 34.138.140.223
  • 34.138.161.100
  • 35.231.250.193
  • 35.196.71.29
  • 34.138.56.192

To request the static IP add-on for your workspace, please contact us.

Create a workspace

Creating a workspace gives you a blank canvas for new connections. Each workspace is completely distinct from the next.

  1. Click the current workspace name in the top left of the dashboard.
  2. Click + Add Workspace at the bottom of the drop down.
  3. Give your new workspace a name and click + Create .
  4. You will be taken to your new workspace. To return to a previous workspace, click the current workspace name in the top left of the dashboard and select the desired option in the drop down.

Edit a workspace

Editing a workspace lets you change various configurations, such as workspace name, notification preferences, members, plan, and billing information.

  1. If you are not already inside the relevant workspace, click the current workspace name in the top left of the dashboard and select the desired workspace in the drop down.
  2. Once inside the relevant workspace, click the current workspace name in the top left of the dashboard.
  3. Click Workspace Settings .
  4. Select the desired tab on the left to navigate workspace configurations.

Manage workspace members

Managing workspace members lets you share connections, event history, issues, and more with your whole team.

  1. If you are not already inside the relevant workspace, click the current workspace name in the top left of the dashboard and select the desired workspace in the drop down.
  2. Once inside the relevant workspace, click the current workspace name in the top left of the dashboard.
  3. Click Workspace Settings .
  4. Click the Members tab.
  5. Click + Add .
  6. Input the email address(es) of the new member(s).
  7. Click Confirm .
  8. The new workspace members will now appear in the Members list.

Manage workspace integrations

Workspace integrations are additional channels where you can receive notifications from Issue Triggers.

  1. Select the Workspace name in the top left of the dashboard for the menu dropdown.
  2. Click Workspace Settings .
  3. Within the General tab, scroll down to the Workspace Integrations section.
  4. Select the Integration you wish to add.
  5. Follow the "Get Started" specific to each Integration.
  6. Click Confirm .
  7. The Integration will now appear as Connected.
  8. Click Disconnect to remove Integration.

Current Workspace Integrations are Slack and Opsgenie. Request an integration by sending us a message.

Set a custom domain

Setting a custom domain let's you change the default domain for your Hookdeck provided URLs. This is useful if you want to customize the URLs you share with your customers or embed into your clients that generate events. Setting a custom domain does not impact receiving traffic on the original Hookdeck assigned url, it will remain valid.

  1. If you are not already inside the relevant workspace, click the current workspace name in the top left of the dashboard and select the desired workspace in the drop down.
  2. Once inside the relevant workspace, click the current workspace name in the top left of the dashboard.
  3. Click Workspace Settings .
  4. Scroll to the "Custom Domain" section of the general settings.
  5. Click Configure Domain .
  6. Input the domain your want to use. The domain name must be a subdomain of your registered domain name.
  7. Click Configure .
  8. Update your DNS configure with the provided TXT and CNAME configuration.
  9. Click the refresh icon to check the validation status. Once "active" your custom domain is ready to use.