A source is any service that sends you webhooks.
How sources work
Each source is given a unique Hookdeck URL that can be pasted into the webhook URL field of the sender platform. Once your provider is sending webhooks to a Hookdeck URL, events are ingested and routed according to your connection rules.
Hookdeck aims to be compatible with every API provider. To accomplish this, we remain platform-agnostic and ingest any inbound requests (up to 10 MiB) with one of the following content-types:
If you encounter a problem integrating a specific API provider, send us a message.
Some providers send webhooks in non-
POST methods, e.g.
PATCH or even
GET. Those are not accepted by default, but you can enable them explicitly by using a
x-hookdeck-allow-methods query string parameter in your Hookdeck source URL
The value is a comma-separated list of the methods to allow, e.g.:
Some API vendors modify their behavior based on the response they receive from a webhook. For these providers, Hookdeck supports setting custom responses through the use of the query string parameter
Append one of the following query parameters to the Hookdeck-provided source URL to achieve the desired response.
|Response||Query parameter example||Behavior|
|Empty||Hookdeck responds with an empty body|
|Text||Hookdeck responds with the text |
|JSON||Hookdeck responds with the specified JSON|
Handshakes and validation
Some API providers require a validation step, known as a "handshake" or "challenge." While this is not standard across all providers, we do our best to implement validation for any platform that our users integrate with.
At this time, we've implemented handshake support for the following platforms:
- Adobe Acrobat Sign
- Twitter (must use our Twitter integration)
- WebSub generic integration
- REST Hooks implementation
If your provider requires a handshake and is missing from this list, contact us and we will add support within 24 hours.