Hookdeck
Docs
CLI
API
Guides
Blog
Use for Free

Get Started

IntroductionGet StartedUsing The API

Webhook Connections

Webhook DeliveryManaging ConnectionsSourcesWhat is a SourceIntegrationCreate a SourceEdit a SourceArchive a SourceUnarchive a SourceDestinationsRules & RulesetFiltering Webhook Events

Webhook Events

Events & AttemptsBrowsing EventsRetry Webhook EventsBookmarks

Development

Development WorkflowUsing The Hookdeck CLI

Best Practices

Replacing your webhook queueSync Versus Async HandlingSignature VerificationImplementing IdempotencyIntegrating With CI & CD

Sources

What is a Source

A Source is used to define the sender of your webhooks. Generally, this will be labeled after the platform you are using such as Shopify, Github, Intercom, etc.

Each Source is associated with a Webhook URL that can be copy & paste as your URL in the sender platform.

Be as descriptive as possible, it will help you keep track of your webhook events!

Integration

Hookdeck's goal is to work with every API provider. However, we do not create integrations with specific API providers. Instead, we aim to stay fully platform agnostic while supporting as many providers as possible. As long as your API Provider supports webhooks with HTTP POST, it should be compatible.

If you encounter a problem with a specific API provider, send us a message, we'll figure it out for you.

Some API providers require a validation step. While this is not standard across all providers we do our best to implement validation for any platforms our users integrate.

Content-Type Support

Different webhook providers might send the data in different formats. The format is determined using the Content-Type HTTP header. Currently, Hookdeck supports:

  • text/plain
  • application/json
  • application/x-www-form-urlencoded
  • application/xml

All of Hookdeck features are available for all content types. Event requests will be converted and stored in JSON behind the scene. Your Destination will receive the request with the original content type preserved.

Create a Source

A Source can be created while creating a new Webhook Connection

Create a Source

FieldDescriptionRequired
nameYour API Provider nametrue

Edit a Source

You can edit A Source via the options menu next to the source name.

Update a Source

Archive a Source

Source can be archived by selecting the archive button in the menu next to the source name or via the API.

Archive a Source

Archiving a Source will also archive all of its connections.

Unarchive a Source

Archived Source can be found in Resources (right sidebar) under Sources and Archived. To unarchive a Source, select the unarchive button in the three dot menu.

Unarchive a Source

When a Source is unarchived, you will need to unarchive each of its connections as well individually.

Managing ConnectionsDestinations