Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Hookdeck Sources API

Manage sources — the upstream endpoints (webhook senders or push channels) that ingest events into Hookdeck. Sources support platform-specific verification (Stripe, GitHub, Twilio, Shopify, and many more), allowed HTTP methods, allowed content types, allowed IPs, and a configurable custom response returned to the caller.

Hookdeck Sources API is one of 17 APIs that Hookdeck publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Webhooks, Sources, and Event Gateways. The published artifact set on APIs.io includes API documentation, an OpenAPI specification, and 1 JSON Schema.

This API exposes 11 operations across 7 paths, and defines 427 schemas. It is described by OpenAPI 3.0.1, at version 1.0.0.

Requests are made against a single base URL, https://api.hookdeck.com/2025-07-01.

11 operations 7 paths 427 schemas 1 DELETE3 GET1 POST6 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0.0
Base URL
https://api.hookdeck.com/2025-07-01
Authentication
HTTP Bearer, HTTP Basic
Resource Areas
1

Authentication & Security 2

Hookdeck Sources API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

Paths & Operations 11

Across 7 paths, the API surfaces 11 operations — 1 DELETE, 3 GET, 1 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.

Sources 11

A source represents any third party that sends webhooks to Hookdeck.

GET
/sources
Retrieve sources
getSources 10 params → 200400422
POST
/sources
Create a source
createSource body → 200400422
PUT
/sources
Create/Update a source
upsertSource body → 200400422
GET
/sources/count
Count sources
countSources → 200400422
GET
/sources/{id}
Retrieve a source
getSource 2 params → 200404410
PUT
/sources/{id}
Update a source
updateSource 1 param body → 200400404422
DELETE
/sources/{id}
Delete a source
deleteSource 1 param → 200404
PUT
/sources/{id}/disable
Disable a source
disableSource 1 param → 200404
PUT
/sources/{id}/archive
Disable a source
disableSource_archive 1 param → 200404
PUT
/sources/{id}/enable
Enable a source
enableSource 1 param → 200404
PUT
/sources/{id}/unarchive
Enable a source
enableSource_unarchive 1 param → 200404

Schemas 427

The contract defines 427 schemas that model the data the API accepts and returns. The most detailed are Source (11 properties), Operators (6 properties), SourceConfigWebhookAuthEbay (5 properties), SeekPagination (5 properties). Each schema is shown below with its type and property counts.

SourceTypeConfigUSPS
object
The type config for USPS. Requires type to be USPS.
3 properties
SourceTypeConfigZOOM
object
The type config for ZOOM. Requires type to be ZOOM.
3 properties
SourceConfigAsanaAuth
object
1 property 1 required
SourceConfigWebhookAuthDocuSign
object
1 property 1 required
SourceConfigWebhookAuthFireblocks
object
1 property 1 required
SourceConfigWebhookAuthGreenDot
object
2 properties 2 required
SourceConfigGitLabAuth
object
1 property 1 required
SourceTypeConfigSTRIPE
object
The type config for STRIPE. Requires type to be STRIPE.
3 properties
SourceTypeConfigRING_CENTRAL
object
The type config for RINGCENTRAL. Requires type to be RINGCENTRAL.
3 properties
SourceConfigWebhookAuthMailchimp
object
1 property 1 required
SourceConfigWebhookAuthZoom
object
1 property 1 required
SourceCustomResponseContentType
string
Content type of the custom response
SourceTypeConfigRECURLY
object
The type config for RECURLY. Requires type to be RECURLY.
3 properties
SourceTypeConfigGREENDOT
object
The type config for GREENDOT. Requires type to be GREENDOT.
3 properties
SourceConfigWebhookAuthTwilio
object
1 property 1 required
SourceConfigMerakiAuth
object
1 property 1 required
SourceConfigBridgeAPIAuth
object
1 property 1 required
SourceTypeConfigTWITCH
object
The type config for TWITCH. Requires type to be TWITCH.
3 properties
SourceConfigLinkedInAuth
object
1 property 1 required
SourceConfigCoinbaseAuth
object
1 property 1 required
SourceConfigWebhookAuthSmartcar
object
1 property 1 required
SourceConfigShipHeroAuth
object
1 property 1 required
SourceTypeConfigPAYPAL
object
The type config for PAYPAL. Requires type to be PAYPAL.
3 properties
SourceConfigNuvemshopAuth
object
1 property 1 required
SourceTypeConfigADYEN
object
The type config for ADYEN. Requires type to be ADYEN.
3 properties
SourceTypeConfigSENDGRID
object
The type config for SENDGRID. Requires type to be SENDGRID.
3 properties
SourceConfigFavroAuth
object
1 property 1 required
SourceConfigBigCommerceAuth
object
1 property 1 required
SourceConfigRingCentralAuth
object
1 property 1 required
SourceTypeConfigSANITY
object
The type config for SANITY. Requires type to be SANITY.
3 properties
SourceConfigBridgeStablecoinsAuth
object
1 property 1 required
SourceConfigLithicAuth
object
1 property 1 required
SourceConfigTwilioAuth
object
1 property 1 required
SourceConfigWebhookAuthFaundit
object
1 property 1 required
SourceConfigHTTPAuth
object
SourceTypeConfigDOCUSIGN
object
The type config for DOCUSIGN. Requires type to be DOCUSIGN.
3 properties
SourceConfigSvixAuth
object
1 property 1 required
SourceConfigFiservAuth
object
2 properties 1 required
SourceConfigMailchimpAuth
object
1 property 1 required
SourceTypeConfigCURSOR
object
The type config for CURSOR. Requires type to be CURSOR.
3 properties
SourceTypeConfigSQUARE
object
The type config for SQUARE. Requires type to be SQUARE.
3 properties
SourceConfigMicrosoftSharePointAuth
object
SourceConfigHTTPAuthHMAC
object
4 properties
SourceConfigWebhookAuth3dEye
object
1 property 1 required
SourceConfigWebhookAuthTwitch
object
1 property 1 required
SourcePaginatedResult
object
3 properties
SourceTypeConfigZENDESK
object
The type config for ZENDESK. Requires type to be ZENDESK.
3 properties
SourceConfigBondsmithAuth
object
1 property 1 required
SourceTypeConfigPICQER
object
The type config for PICQER. Requires type to be PICQER.
3 properties
SourceConfigWebhookAuthOkta
object
1 property 1 required
SourceConfigWhatsAppAuth
object
1 property 1 required
SourceConfigWebhookAuthOura
object
1 property 1 required
SourceConfigPipedriveAuth
object
2 properties 2 required
SourceTypeConfigPIPEDRIVE
object
The type config for PIPEDRIVE. Requires type to be PIPEDRIVE.
3 properties
SourceTypeConfigHUBSPOT
object
The type config for HUBSPOT. Requires type to be HUBSPOT.
3 properties
SourceTypeConfigWIX
object
The type config for WIX. Requires type to be WIX.
3 properties
SourceConfigFireblocksAuth
object
1 property 1 required
SeekPagination
object
5 properties
SourceTypeConfigFRONTAPP
object
The type config for FRONTAPP. Requires type to be FRONTAPP.
3 properties
SourceConfigUSPSAuth
object
1 property 1 required
SourceConfigWebhookAuthAlchemy
object
1 property 1 required
SourceConfigWebhookAuthSynctera
object
1 property 1 required
SourceTypeConfigASANA
object
The type config for ASANA. Requires type to be ASANA.
3 properties
SourceConfigWebhookAuthChargebeeBilling
object
2 properties 2 required
SourceTypeConfigINTERCOM
object
The type config for INTERCOM. Requires type to be INTERCOM.
3 properties
SourceConfigStripeAuth
object
1 property 1 required
SourceConfigWebhookAuthShopline
object
1 property 1 required
SourceConfigWebhookAuthPaymob
object
1 property 1 required
SourceTypeConfigTWILIO
object
The type config for TWILIO. Requires type to be TWILIO.
3 properties
SourceTypeConfigSYNCTERA
object
The type config for SYNCTERA. Requires type to be SYNCTERA.
3 properties
SourceConfigDocuSignAuth
object
1 property 1 required
SourceConfigTwitchAuth
object
1 property 1 required
SourceConfigFusionAuthAuth
object
1 property 1 required
SourceConfigWebhookAuthSvix
object
1 property 1 required
SourceConfigWebhookAuthPraxis
object
1 property 1 required
SourceTypeConfigCOMMERCELAYER
object
The type config for COMMERCELAYER. Requires type to be COMMERCELAYER.
3 properties
SourceConfigWebhookAuthStripe
object
1 property 1 required
SourceConfigPaddleAuth
object
1 property 1 required
SourceConfigWebhookAuthOpenAI
object
1 property 1 required
SourceTypeConfigFUSIONAUTH
object
The type config for FUSIONAUTH. Requires type to be FUSIONAUTH.
3 properties
SourceConfigWebhookAuthAlipay
object
1 property 1 required
SourceTypeConfigNUVEMSHOP
object
The type config for NUVEMSHOP. Requires type to be NUVEMSHOP.
3 properties
SourceConfigPersonaAuth
object
1 property 1 required
SourceConfigWebhookAuthPaypal
object
1 property 1 required
SourceConfigWebhookAuthEmpty
SourceConfigPraxisAuth
object
1 property 1 required
SourceConfigWebhookAuthAirtable
object
1 property 1 required
SourceConfigCourierAuth
object
1 property 1 required
SourceTypeConfigPORTAL
object
The type config for PORTAL. Requires type to be PORTAL.
3 properties
SourceConfigUpolloAuth
object
1 property 1 required
SourceConfigWebhookAuthHubspot
object
1 property 1 required
SourceTypeConfigQUOTER
object
The type config for QUOTER. Requires type to be QUOTER.
3 properties
SourceConfigWebhookAuthLithic
object
1 property 1 required
SourceConfigShipBobAuth
object
1 property 1 required
SourceConfigRepayAuth
object
1 property 1 required
SourceConfigWebhookAuthTikTokShop
object
2 properties 2 required
SourceConfigWebhookAuthWhatsApp
object
1 property 1 required
SourceConfigWebhookAuthUber
object
1 property 1 required
SourceConfigWebhookAuthZendesk
object
1 property 1 required
SourceConfigWebhookAuthGitHub
object
1 property 1 required
SourceConfigWebhookAuthResend
object
1 property 1 required
SourceTypeConfigFASTSPRING
object
The type config for FASTSPRING. Requires type to be FASTSPRING.
3 properties
SourceConfigWebhookAuthBasicAuth
object
2 properties 2 required
SourceConfigTypeformAuth
object
1 property 1 required
SourceConfigSyncteraAuth
object
1 property 1 required
SourceConfigWebhookAuthIntercom
object
1 property 1 required
SourceConfigWebhookAuthTreezor
object
1 property 1 required
SourceConfigWeChatPayAuth
object
1 property 1 required
SourceTypeConfigTIKTOK
object
The type config for TIKTOK. Requires type to be TIKTOK.
3 properties
SourceConfigWebhookAuthAsana
object
1 property 1 required
SourceTypeConfigAIPRISE
object
The type config for AIPRISE. Requires type to be AIPRISE.
3 properties
SourceTypeConfigTHREE_D_EYE
object
The type config for THREEDEYE. Requires type to be THREEDEYE.
3 properties
SourceConfigZeroHashAuth
object
1 property 1 required
SourceTypeConfigSHOPLINE
object
The type config for SHOPLINE. Requires type to be SHOPLINE.
3 properties
SourceConfigCustomer.IOAuth
object
1 property 1 required
SourceConfigWebhookAuthBridgeStablecoins
object
1 property 1 required
SourceConfigWebhookAuthRepay
object
1 property 1 required
SourceConfigWebhookAuthClaude
object
1 property 1 required
SourceTypeConfigGITHUB
object
The type config for GITHUB. Requires type to be GITHUB.
3 properties
SourceConfigWebhookAuthAirwallex
object
1 property 1 required
SourceConfigWebhookAuthTelnyx
object
1 property 1 required
SourceTypeConfigSHOPIFY
object
The type config for SHOPIFY. Requires type to be SHOPIFY.
3 properties
SourceConfigPortalAuth
object
1 property 1 required
SourceTypeConfigOPENAI
object
The type config for OPENAI. Requires type to be OPENAI.
3 properties
SourceConfigWebhookAuthLinear
object
1 property 1 required
SourceTypeConfigXERO
object
The type config for XERO. Requires type to be XERO.
3 properties
SourceConfigFrontAppAuth
object
1 property 1 required
SourceConfigSmileAuth
object
1 property 1 required
SourceConfigWebhookAuthFireflies.ai
object
1 property 1 required
SourceConfigWebhookAuthUpollo
object
1 property 1 required
SourceConfigWebhookAuthVercelWebhooks
object
1 property 1 required
SourceConfigOrbAuth
object
1 property 1 required
SourceTypeConfigMICROSOFT_SHAREPOINT
object
The type config for MICROSOFTSHAREPOINT. Requires type to be MICROSOFTSHAREPOINT.
3 properties
SourceConfigWebhookAuthNMIPaymentGateway
object
1 property 1 required
SourceTypeConfigGOCARDLESS
object
The type config for GOCARDLESS. Requires type to be GOCARDLESS.
3 properties
SourceTypeConfigWECHAT
object
The type config for WECHAT. Requires type to be WECHAT.
3 properties
SourceTypeConfigGEMINI
object
The type config for GEMINI. Requires type to be GEMINI.
3 properties
SourceTypeConfigNMI
object
The type config for NMI. Requires type to be NMI.
3 properties
SourceConfigWebhookAuthX
object
1 property 1 required
SourceConfigWebhookAuthTypeform
object
1 property 1 required
SourceConfigFireflies.aiAuth
object
1 property 1 required
SourceConfigGreenDotAuth
object
2 properties 2 required
SourceAllowedHTTPMethod
array
List of allowed HTTP methods. Defaults to PUT, POST, PATCH, DELETE.
SourceTypeConfigCLAUDE
object
The type config for CLAUDE. Requires type to be CLAUDE.
3 properties
SourceTypeConfig
object
The type configs for the specified type
SourceConfigResendAuth
object
1 property 1 required
SourceConfigWebhookAuthBigCommerce
object
1 property 1 required
SourceConfigXAuth
object
1 property 1 required
SourceTypeConfigMONDAY
object
The type config for MONDAY. Requires type to be MONDAY.
3 properties
SourceTypeConfigNYLAS
object
The type config for NYLAS. Requires type to be NYLAS.
3 properties
SourceConfigPostmarkAuth
object
2 properties 2 required
SourceTypeConfigTWITTER
object
The type config for TWITTER. Requires type to be TWITTER.
3 properties
SourceConfigWebhookAuthTrello
object
1 property 1 required
SourceConfigWebhookAuthCursor
object
1 property 1 required
SourceTypeConfigPAYPRO_GLOBAL
object
The type config for PAYPROGLOBAL. Requires type to be PAYPROGLOBAL.
3 properties
SourceTypeConfigSTRAVA
object
The type config for STRAVA. Requires type to be STRAVA.
3 properties
SourceConfigStravaAuth
object
SourceTypeConfigEBAY
object
The type config for EBAY. Requires type to be EBAY.
3 properties
SourceConfigManagedAuth
object
SourceTypeConfigWORKOS
object
The type config for WORKOS. Requires type to be WORKOS.
3 properties
SourceConfigWebhookAuthXero
object
1 property 1 required
SourceConfigAirwallexAuth
object
1 property 1 required
SourceConfigUtilaAuth
object
1 property 1 required
SourceConfigWebhookAuthGitLab
object
1 property 1 required
SourceConfigCursorAuth
object
1 property 1 required
SourceTypeConfigOURA
object
The type config for OURA. Requires type to be OURA.
3 properties
SourceConfigGoCardlessAuth
object
1 property 1 required
SourceTypeConfigFACEBOOK
object
The type config for FACEBOOK. Requires type to be FACEBOOK.
3 properties
SourceConfigWebhookAuthFusionAuth
object
1 property 1 required
SourceConfigWebhookAuthNuvemshop
object
1 property 1 required
SourceConfigHTTPAuthAPIKey
object
2 properties
SourceTypeConfigPROPERTYFINDER
object
The type config for PROPERTY-FINDER. Requires type to be PROPERTY-FINDER.
3 properties
SourceTypeConfigMAILGUN
object
The type config for MAILGUN. Requires type to be MAILGUN.
3 properties
SourceConfigScrapflyAuth
object
1 property 1 required
SourceTypeConfigSLACK
object
The type config for SLACK. Requires type to be SLACK.
3 properties
SourceConfigWebhookAuthPostmark
object
2 properties 2 required
SourceTypeConfigDISCORD
object
The type config for DISCORD. Requires type to be DISCORD.
3 properties
SourceConfigWebhookAuthTally
object
1 property 1 required
SourceConfigWebhookAuthGoogleGemini
object
1 property 1 required
SourceConfigPolarAuth
object
1 property 1 required
SourceConfigWebhookAuthHMAC
object
4 properties 4 required
SourceConfigDiscordAuth
object
1 property 1 required
SourceConfigWebhookAuthFrontApp
object
1 property 1 required
SourceConfigPropertyFinderAuth
object
1 property 1 required
SourceConfigWebhookAuthWalmart
object
1 property 1 required
SourceConfigWebhookAuthSmile
object
1 property 1 required
SourceTypeConfigSMILE
object
The type config for SMILE. Requires type to be SMILE.
3 properties
SourceConfigTikTokAuth
object
1 property 1 required
SourceTypeConfigBRIDGE_XYZ
object
The type config for BRIDGEXYZ. Requires type to be BRIDGEXYZ.
3 properties
SourceConfigWebhookAuthBridgeAPI
object
1 property 1 required
SourceTypeConfigASCEND
object
The type config for ASCEND. Requires type to be ASCEND.
3 properties
SourceConfigWebhookAuthCircle
object
1 property 1 required
SourceConfigWebhookAuthPaystack
object
1 property 1 required
SourceConfigWebhookAuthAWSSNS
object
SourceConfig3dEyeAuth
object
1 property 1 required
SourceConfigWebhookAuthAdyen
object
1 property 1 required
SourceConfigShoplineAuth
object
1 property 1 required
SourceTypeConfigWALMART
object
The type config for WALMART. Requires type to be WALMART.
3 properties
SourceConfigZendeskAuth
object
1 property 1 required
SourceTypeConfigFIREBLOCKS
object
The type config for FIREBLOCKS. Requires type to be FIREBLOCKS.
3 properties
SourceTypeConfigMAILCHIMP
object
The type config for MAILCHIMP. Requires type to be MAILCHIMP.
3 properties
SourceConfigHookdeckPublishAPIAuth
object
SourceConfigGoogleGeminiAuth
object
1 property 1 required
SourceConfigWebhookAuthOrb
object
1 property 1 required
SourceTypeConfigAKENEO
object
The type config for AKENEO. Requires type to be AKENEO.
3 properties
SourceConfigChargebeeBillingAuth
object
2 properties 2 required
SourceTypeConfigSCRAPFLY
object
The type config for SCRAPFLY. Requires type to be SCRAPFLY.
3 properties
SourceConfigWebhookAuthRecharge
object
1 property 1 required
SourceConfigNMIPaymentGatewayAuth
object
1 property 1 required
SourceTypeConfigTALLY
object
The type config for TALLY. Requires type to be TALLY.
3 properties
SourceConfigSmartcarAuth
object
1 property 1 required
SourceConfigRecurlyAuth
object
1 property 1 required
SourceConfigTallyAuth
object
1 property 1 required
SourceConfigTebexAuth
object
1 property 1 required
SourceConfigWebhookAuthWix
object
1 property 1 required
SourceConfigClaudeAuth
object
1 property 1 required
SourceConfigWebhookAuthFlexport
object
1 property 1 required
SourceConfigTrelloAuth
object
1 property 1 required
SourceConfigWebhookAuthWorkOS
object
1 property 1 required
SourceConfigLinearAuth
object
1 property 1 required
SourceTypeConfigSVIX
object
The type config for SVIX. Requires type to be SVIX.
3 properties
SourceConfigWebhookAuthCoinbase
object
1 property 1 required
SourceConfigWebhookAuthSquare
object
1 property 1 required
SourceConfigWebhookAuthCommerceLayer
object
1 property 1 required
SourceConfigWebhookAuthCloudSignal
object
1 property 1 required
SourceConfigAshbyAuth
object
1 property 1 required
SourceConfigOuraAuth
object
1 property 1 required
SourceConfigWebhookAuthShipBob
object
1 property 1 required
SourceTypeConfigCHARGEBEE_BILLING
object
The type config for CHARGEBEEBILLING. Requires type to be CHARGEBEEBILLING.
3 properties
SourceTypeConfigPOLAR
object
The type config for POLAR. Requires type to be POLAR.
3 properties
SourceConfigTikTokShopAuth
object
2 properties 2 required
SourceTypeConfigFAVRO
object
The type config for FAVRO. Requires type to be FAVRO.
3 properties
SourceConfigWebhookAuthPylon
object
1 property 1 required
OrderByDirection
SourceTypeConfigTOKENIO
object
The type config for TOKENIO. Requires type to be TOKENIO.
3 properties
SourceConfigReplicateAuth
object
1 property 1 required
SourceConfigWebhookAuthShopify
object
1 property 1 required
SourceConfigExactOnlineAuth
object
1 property 1 required
SourceConfigWooCommerceAuth
object
1 property 1 required
SourceTypeConfigREVOLUT
object
The type config for REVOLUT. Requires type to be REVOLUT.
3 properties
Source
object
Associated [Source](source-object) object
11 properties 9 required
SourceConfigWebhookAuthUtila
object
1 property 1 required
SourceConfigMicrosoftGraphAuth
object
SourceConfigWebhookAuthWooCommerce
object
1 property 1 required
SourceTypeConfigMANAGED
object
1 property
SourceConfigWebhookAuthTebex
object
1 property 1 required
SourceTypeConfigAIRWALLEX
object
The type config for AIRWALLEX. Requires type to be AIRWALLEX.
3 properties
SourceTypeConfigPRAXIS
object
The type config for PRAXIS. Requires type to be PRAXIS.
3 properties
SourceConfigWebhookAuthPolar
object
1 property 1 required
SourceTypeConfigSMARTCAR
object
The type config for SMARTCAR. Requires type to be SMARTCAR.
3 properties
SourceTypeConfigHOOKDECK_OUTPOST
object
The type config for HOOKDECKOUTPOST. Requires type to be HOOKDECKOUTPOST.
3 properties
SourceTypeConfigMERAKI
object
The type config for MERAKI. Requires type to be MERAKI.
3 properties
SourceConfigWebhookAuthAkeneo
object
1 property 1 required
SourceTypeConfigRAZORPAY
object
The type config for RAZORPAY. Requires type to be RAZORPAY.
3 properties
SourceConfigTreezorAuth
object
1 property 1 required
SourceConfigWebhookAuthNylas
object
1 property 1 required
SourceConfigSendgridAuth
object
1 property 1 required
SourceConfigEbayAuth
object
5 properties 5 required
SourceConfigWebhookAuthNeon
object
1 property 1 required
SourceTypeConfigVERCEL_LOG_DRAINS
object
The type config for VERCELLOGDRAINS. Requires type to be VERCELLOGDRAINS.
3 properties
SourceTypeConfigFISERV
object
The type config for FISERV. Requires type to be FISERV.
3 properties
SourceConfigHTTPAuthEmpty
SourceConfigWebhookAuthPipedrive
object
2 properties 2 required
SourceTypeConfigAWS_SNS
object
The type config for AWSSNS. Requires type to be AWSSNS.
3 properties
SourceConfigEnodeAuth
object
1 property 1 required
SourceConfigWorkOSAuth
object
1 property 1 required
SourceTypeConfigWEBHOOK
object
The type config for WEBHOOK. Requires type to be WEBHOOK.
4 properties
SourceConfigWebhookAuthQuoter
object
1 property 1 required
SourceConfigVercelWebhooksAuth
object
1 property 1 required
SourceConfigGitHubAuth
object
1 property 1 required
SourceTypeConfigTEBEX
object
The type config for TEBEX. Requires type to be TEBEX.
3 properties
SourceConfigWebhookAuthFastSpring
object
1 property 1 required
SourceConfigWebhookAuthEbay
object
5 properties 5 required
SourceConfigRevolutAuth
object
1 property 1 required
SourceTypeConfigLITHIC
object
The type config for LITHIC. Requires type to be LITHIC.
3 properties
SourceConfigHTTPAuthBasicAuth
object
2 properties
SourceTypeConfigBONDSMITH
object
The type config for BONDSMITH. Requires type to be BONDSMITH.
3 properties
SourceTypeConfigCOURIER
object
The type config for COURIER. Requires type to be COURIER.
3 properties
SourceTypeConfigFAUNDIT
object
The type config for FAUNDIT. Requires type to be FAUNDIT.
3 properties
APIErrorResponse
object
Error response model
4 properties 3 required
SourceConfig
object
Configuration object for the source type
SourceConfigWebhookAuthPropertyFinder
object
1 property 1 required
SourceTypeConfigPERSONA
object
The type config for PERSONA. Requires type to be PERSONA.
3 properties
SourceTypeConfigCUSTOMERIO
object
The type config for CUSTOMERIO. Requires type to be CUSTOMERIO.
3 properties
SourceConfigAkeneoAuth
object
1 property 1 required
SourceConfigZoomAuth
object
1 property 1 required
SourceTypeConfigCHAINDOTS
object
The type config for CHAINDOTS. Requires type to be CHAINDOTS.
3 properties
SourceConfigPayProGlobalAuth
object
1 property 1 required
SourceConfigSanityAuth
object
1 property 1 required
SourceConfigWebhookAuthBondsmith
object
1 property 1 required
SourceConfigZiftAuth
object
SourceConfigAlipayAuth
object
1 property 1 required
SourceConfigXeroAuth
object
1 property 1 required
SourceConfigRazorpayAuth
object
1 property 1 required
SourceConfigNeonAuth
object
1 property 1 required
SourceTypeConfigPOSTMARK
object
The type config for POSTMARK. Requires type to be POSTMARK.
3 properties
SourceConfigNylasAuth
object
1 property 1 required
SourceConfigPicqerAuth
object
1 property 1 required
SourceConfigRechargeAuth
object
1 property 1 required
SourceTypeConfigHTTP
object
The type config for HTTP. Requires type to be HTTP.
4 properties
SourceConfigWebhookAuthCourier
object
1 property 1 required
SourceConfigWebhookAuthAPIKey
object
2 properties 2 required
SourceConfigAWSSNSAuth
object
SourceConfigWebhookAuthRazorpay
object
1 property 1 required
SourceConfigFacebookAuth
object
1 property 1 required
SourceTypeConfigREPLICATE
object
The type config for REPLICATE. Requires type to be REPLICATE.
3 properties
SourceConfigFastSpringAuth
object
1 property 1 required
SourceTypeConfigRESEND
object
The type config for RESEND. Requires type to be RESEND.
3 properties
SourceConfigWebhookAuthVercelDrains
object
1 property
SourceTypeConfigPAYSTACK
object
The type config for PAYSTACK. Requires type to be PAYSTACK.
3 properties
SourceTypeConfigTREEZOR
object
The type config for TREEZOR. Requires type to be TREEZOR.
3 properties
SourceTypeConfigSHIPBOB
object
The type config for SHIPBOB. Requires type to be SHIPBOB.
3 properties
SourceConfigWebhookAuthPicqer
object
1 property 1 required
SourceTypeConfigPAYMOB
object
The type config for PAYMOB. Requires type to be PAYMOB.
3 properties
SourceConfigShopifyAuth
object
1 property 1 required
SourceTypeConfigZEROHASH
object
The type config for ZEROHASH. Requires type to be ZEROHASH.
3 properties
SourceTypeConfigTIKTOK_SHOP
object
The type config for TIKTOKSHOP. Requires type to be TIKTOKSHOP.
3 properties
SourceConfigCloudSignalAuth
object
1 property 1 required
SourceTypeConfigTELNYX
object
The type config for TELNYX. Requires type to be TELNYX.
3 properties
SourceConfigWebhookAuthPaddle
object
1 property 1 required
SourceTypeConfigLINEAR
object
The type config for LINEAR. Requires type to be LINEAR.
3 properties
SourceTypeConfigPADDLE
object
The type config for PADDLE. Requires type to be PADDLE.
3 properties
SourceConfigClioAuth
object
1 property 1 required
SourceTypeConfigORB
object
The type config for ORB. Requires type to be ORB.
3 properties
SourceConfigAipriseAuth
object
1 property 1 required
SourceConfigQuoterAuth
object
1 property 1 required
SourceTypeConfigBRIDGE_API
object
The type config for BRIDGEAPI. Requires type to be BRIDGEAPI.
3 properties
SourceConfigWebhookAuthAiprise
object
1 property 1 required
SourceTypeConfigPUBLISH_API
object
The type config for PUBLISHAPI. Requires type to be PUBLISHAPI.
3 properties
SourceConfigWebhookAuthShipHero
object
1 property 1 required
SourceConfigTelnyxAuth
object
1 property 1 required
SourceConfigWebhookAuthFavro
object
1 property 1 required
SourceConfigWebhookAuthMailgun
object
1 property 1 required
SourceTypeConfigUTILA
object
The type config for UTILA. Requires type to be UTILA.
3 properties
SourceConfigWebhookAuthAscend
object
1 property 1 required
SourceConfigCircleAuth
object
1 property 1 required
SourceConfigWebhookAuthRevolut
object
1 property 1 required
SourceTypeConfigSHIPHERO
object
The type config for SHIPHERO. Requires type to be SHIPHERO.
3 properties
SourceConfigWebhookAuthExactOnline
object
1 property 1 required
SourceTypeConfigGITLAB
object
The type config for GITLAB. Requires type to be GITLAB.
3 properties
SourceConfigEthocaAuth
object
SourceConfigWebhookAuthClio
object
1 property 1 required
SourceConfigWebhookAuthZeroHash
object
1 property 1 required
SourceTypeConfigUBER
object
The type config for UBER. Requires type to be UBER.
3 properties
SourceTypeConfigASHBY
object
The type config for ASHBY. Requires type to be ASHBY.
3 properties
SourceTypeConfigOKTA
object
The type config for OKTA. Requires type to be OKTA.
3 properties
SourceConfigWebhookAuthEnode
object
1 property 1 required
SourceConfigWebhookAuthRingCentral
object
1 property 1 required
SourceTypeConfigAIRTABLE
object
The type config for AIRTABLE. Requires type to be AIRTABLE.
3 properties
SourceConfigWebhookAuthFiserv
object
2 properties 1 required
SourceConfigFlexportAuth
object
1 property 1 required
SourceConfigWebhookAuth
object
SourceTypeConfigFLEXPORT
object
The type config for FLEXPORT. Requires type to be FLEXPORT.
3 properties
SourceConfigWixAuth
object
1 property 1 required
SourceTypeConfigMICROSOFT_GRAPH
object
The type config for MICROSOFTGRAPH. Requires type to be MICROSOFTGRAPH.
3 properties
SourceConfigWalmartAuth
object
1 property 1 required
SourceConfigAdyenAuth
object
1 property 1 required
SourceConfigWebhookAuthTikTok
object
1 property 1 required
SourceConfigWebhookAuthPortal
object
1 property 1 required
SourceConfigOpenAIAuth
object
1 property 1 required
SourceConfigUberAuth
object
1 property 1 required
SourceConfigWebhookAuthChaindots
object
1 property 1 required
SourceCustomResponse
object
Custom response object
2 properties 2 required
SourceConfigWebhookAuthCustomer.IO
object
1 property 1 required
SourceTypeConfigCIRCLE
object
The type config for CIRCLE. Requires type to be CIRCLE.
3 properties
SourceConfigPaystackAuth
object
1 property 1 required
SourceTypeConfigSOLIDGATE
object
The type config for SOLIDGATE. Requires type to be SOLIDGATE.
3 properties
SourceConfigIntercomAuth
object
1 property 1 required
SourceConfigPylonAuth
object
1 property 1 required
SourceConfigAlchemyAuth
object
1 property 1 required
SourceConfigWebhookAuthUSPS
object
1 property 1 required
SourceConfigWebhookAuthScrapfly
object
1 property 1 required
SourceConfigSolidgateAuth
object
1 property 1 required
SourceConfigPaypalAuth
object
1 property 1 required
SourceConfigWebhookAuthSlack
object
1 property 1 required
Operators
object
6 properties
SourceConfigMailgunAuth
object
1 property 1 required
SourceConfigWebhookAuthReplicate
object
1 property 1 required
SourceConfigWebhookAuthSanity
object
1 property 1 required
SourceConfigAirtableAuth
object
1 property 1 required
SourceConfigWebhookAuthWeChatPay
object
1 property 1 required
SourceConfigPaymobAuth
object
1 property 1 required
SourceConfigChaindotsAuth
object
1 property 1 required
SourceTypeConfigCLOUDSIGNAL
object
The type config for CLOUDSIGNAL. Requires type to be CLOUDSIGNAL.
3 properties
SourceTypeConfigALIPAY
object
The type config for ALIPAY. Requires type to be ALIPAY.
3 properties
SourceTypeConfigPYLON
object
The type config for PYLON. Requires type to be PYLON.
3 properties
SourceConfigHubspotAuth
object
1 property 1 required
SourceConfigMondayAuth
object
SourceTypeConfigVERCEL
object
The type config for VERCEL. Requires type to be VERCEL.
3 properties
SourceConfigAscendAuth
object
1 property 1 required
SourceConfigWebhookAuthDiscord
object
1 property 1 required
SourceConfigWebhookAuthRecurly
object
1 property 1 required
SourceConfigWebhookAuthSendgrid
object
1 property 1 required
SourceTypeConfigFIREFLIES
object
The type config for FIREFLIES. Requires type to be FIREFLIES.
3 properties
SourceConfigCommerceLayerAuth
object
1 property 1 required
SourceTypeConfigALCHEMY
object
The type config for ALCHEMY. Requires type to be ALCHEMY.
3 properties
SourceConfigWebhookAuthGoCardless
object
1 property 1 required
SourceTypeConfigEXACT_ONLINE
object
The type config for EXACTONLINE. Requires type to be EXACTONLINE.
3 properties
SourceConfigFaunditAuth
object
1 property 1 required
SourceTypeConfigETHOCA
object
The type config for ETHOCA. Requires type to be ETHOCA.
3 properties
SourceTypeConfigUPOLLO
object
The type config for UPOLLO. Requires type to be UPOLLO.
3 properties
SourceTypeConfigWOOCOMMERCE
object
The type config for WOOCOMMERCE. Requires type to be WOOCOMMERCE.
3 properties
SourceConfigSquareAuth
object
1 property 1 required
SourceConfigWebhookAuthSolidgate
object
1 property 1 required
SourceTypeConfigLINKEDIN
object
The type config for LINKEDIN. Requires type to be LINKEDIN.
3 properties
SourceConfigWebhookAuthLinkedIn
object
1 property 1 required
SourceConfigWebhookAuthPayProGlobal
object
1 property 1 required
SourceConfigWebhookAuthAshby
object
1 property 1 required
SourceTypeConfigENODE
object
The type config for ENODE. Requires type to be ENODE.
3 properties
SourceConfigOktaAuth
object
1 property 1 required
SourceConfigWebhookAuthTokenIO
object
1 property 1 required
SourceConfigWebhookAuthPersona
object
1 property 1 required
SourceTypeConfigCLIO
object
The type config for CLIO. Requires type to be CLIO.
3 properties
SourceTypeConfigTRELLO
object
The type config for TRELLO. Requires type to be TRELLO.
3 properties
SourceTypeConfigZIFT
object
The type config for ZIFT. Requires type to be ZIFT.
3 properties
SourceTypeConfigCOINBASE
object
The type config for COINBASE. Requires type to be COINBASE.
3 properties
SourceConfigWebhookAuthFacebook
object
1 property 1 required
SourceConfigTokenIOAuth
object
1 property 1 required
SourceTypeConfigBIGCOMMERCE
object
The type config for BIGCOMMERCE. Requires type to be BIGCOMMERCE.
3 properties
SourceTypeConfigRECHARGE
object
The type config for RECHARGE. Requires type to be RECHARGE.
3 properties
SourceConfigVercelDrainsAuth
object
1 property
SourceTypeConfigWHATSAPP
object
The type config for WHATSAPP. Requires type to be WHATSAPP.
3 properties
SourceTypeConfigNEON
object
The type config for NEON. Requires type to be NEON.
3 properties
SourceConfigWebhookAuthMeraki
object
1 property 1 required
SourceConfigSlackAuth
object
1 property 1 required
SourceTypeConfigTYPEFORM
object
The type config for TYPEFORM. Requires type to be TYPEFORM.
3 properties
SourceTypeConfigREPAY
object
The type config for REPAY. Requires type to be REPAY.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hookdeck-sources-api-openapi.yml Raw ↑

Other APIs Hookdeck publishes across the network.

Hookdeck Connections API
Hookdeck Destinations API
Hookdeck Events API
Hookdeck Requests API
Hookdeck Transformations API
Hookdeck Bookmarks API
Hookdeck Issues API
Hookdeck Metrics API
Hookdeck Integrations API
Hookdeck Notifications API
Hookdeck Attempts API
Hookdeck Bulk cancel events API