Get Started

Create your account at https://dashboard.hookdeck.com/signup

We support authentication by SSO with Google and Github along with passwordless sign in by Email

Create your workspace

Upon signing up you will be prompted to create your first Workspace.

Enter your workspace name and fill in the form.

Create a webhook connection

The onboarding will guide you through creating your first webhook connection.

Create A Source

A Source is a representation of the service you are planning on receiving your webhooks from. That could be Shopify, Github, Olark, Stripe, or any other service.

For our example project, we will create a Github Source.

create-source

Create a Destination

A Destination is a representation of your own API where the webhooks will be delivered. Each destination requires an HTTP URL that will receive a POST request with a JSON body payload. Each webhook event also contains Hookdeck metadata.

For our example project, we will create a Hookdeck Mock Destination.

create-destination

Create a Ruleset

A ruleset is a reusable set of configurations to set the retry logic and alert logic for any event associated with a webhook.

The retry logic consists of a retry count and a retry interval. The retry count is the number of automatic retry for a failed event and the retry interval is the time between each automatic retry.
The alert logic uses the alert strategy and the alert interval. The alert strategy defines the condition for which you wish to receive an email alert and the alert interval is the minimum time between each email alert.

For our example project, we will use the Default Ruleset that will retry every hour minutes up to 5 times. It will send an email alert for the last failure, with up to 1 email per hour.

create-ruleset

You can create your first connection using the API

 POST https://events.hookdeck.com/webhooks

{
  "source": {
    "label": "Shopify"
  },
  "destination": {
    "label": "My API",
    "url": "https://myapi.example.com/webhook"
  }
}

curl "POST https://api.hookdeck.com/webhooks" \
  -H "Authorization: Basic {{ BASE64_API_TOKEN }}" \
  -H "Content-Type: application/json"
  --data '{"source":{"label":"Shopify"},"destination":{"label":"My API","url":"https://myapi.example.com/webhook"}}'

API reference →

Update the endpoint in the Source

Hookdeck generates a unique URL for each Source. Replace your current endpoint in your Source with Hookdeck's URL.

For our example project, I will update the URL in the config of my GitHub webhook.

copy-url

Github Webhooks UI

paste-url-github

Validate the connection

After replacing the endpoint for Hookdeck's URL. Trigger an action in your source to validate the webhook connection.

Our first event! 🎉

Hookdeck_Event_Test

Congratulations!

You created your first webhook connection. You now have a reliable webhook infrastructure along with full visibility on incoming calls and tools to troubleshoot errors. You can sit back while Hookdeck safely handles and delivers your webhooks.

Introduction Using The API