Hookdeck · Schema
Hookdeck Connection
JSON Schema for the Hookdeck Connection entity, extracted from the Hookdeck Admin REST API (v2025-07-01).
WebhooksEvent GatewaysGatewaysEventsEvent InfrastructureEvent-DrivenMessagingQueuesRetriesTransformationsObservability
Properties
| Name | Type | Description |
|---|---|---|
| id | string | ID of the connection |
| name | string | Unique name of the connection for this source |
| full_name | string | Full name of the connection concatenated from source, connection and desitnation name |
| description | string | Description of the connection |
| team_id | string | ID of the project |
| destination | object | |
| source | object | |
| rules | array | Array of rules configured on the connection |
| disabled_at | string | Date the connection was disabled |
| paused_at | string | Date the connection was paused |
| updated_at | string | Date the connection was last updated |
| created_at | string | Date the connection was created |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/hookdeck/main/json-schema/hookdeck-connection-schema.json",
"title": "Hookdeck Connection",
"description": "JSON Schema for the Hookdeck Connection entity, extracted from the Hookdeck Admin REST API (v2025-07-01).",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the connection"
},
"name": {
"type": "string",
"nullable": true,
"description": "Unique name of the connection for this source"
},
"full_name": {
"type": "string",
"nullable": true,
"description": "Full name of the connection concatenated from source, connection and desitnation name"
},
"description": {
"type": "string",
"nullable": true,
"description": "Description of the connection"
},
"team_id": {
"type": "string",
"description": "ID of the project"
},
"destination": {
"$ref": "#/$defs/Destination"
},
"source": {
"$ref": "#/$defs/Source"
},
"rules": {
"type": "array",
"items": {
"$ref": "#/$defs/Rule"
},
"nullable": true,
"description": "Array of rules configured on the connection"
},
"disabled_at": {
"type": "string",
"format": "date-time",
"nullable": true,
"description": "Date the connection was disabled"
},
"paused_at": {
"type": "string",
"format": "date-time",
"nullable": true,
"description": "Date the connection was paused"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Date the connection was last updated"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Date the connection was created"
}
},
"required": [
"id",
"name",
"full_name",
"description",
"team_id",
"destination",
"source",
"rules",
"disabled_at",
"paused_at",
"updated_at",
"created_at"
],
"additionalProperties": false,
"$defs": {
"SourceTypeConfigCHAINDOTS": {
"type": "object",
"properties": {
"auth": {
"$ref": "#/$defs/SourceConfigChaindotsAuth"
},
"allowed_http_methods": {
"$ref": "#/$defs/SourceAllowedHTTPMethod"
},
"custom_response": {
"$ref": "#/$defs/SourceCustomResponse"
}
},
"additionalProperties": false,
"description": "The type config for CHAINDOTS. Requires type to be `CHAINDOTS`.",
"x-docs-type": "CHAINDOTS"
},
"DestinationTypeConfigCLI": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Path for the CLI destination"
},
"path_forwarding_disabled": {
"type": "boolean"
},
"http_method": {
"type": "string",
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"nullable": true
},
"auth_type": {
"type": "string",
"enum": [
"HOOKDECK_SIGNATURE",
"CUSTOM_SIGNATURE",
"BASIC_AUTH",
"API_KEY",
"BEARER_TOKEN",
"OAUTH2_CLIENT_CREDENTIALS",
"OAUTH2_AUTHORIZATION_CODE",
"AWS_SIGNATURE",
"GCP_SERVICE_ACCOUNT"
],
"nullable": true
},
"auth": {
"$ref": "#/$defs/DestinationConfigCLIAuth"
}
},
"required": [
"path"
],
"additionalProperties": false,
"description": "The type config for CLI. Requires type to be `CLI`.",
"x-docs-type": "CLI"
},
"SourceConfigWebhookAuthChargebeeBilling": {
"type": "object",
"properties": {
"username": {
"type": "string"
},
"password": {
"type": "string"
}
},
"required": [
"username",
"password"
],
"additionalProperties": false,
"x-docs-type": "CHARGEBEE_BILLING"
},
"SourceConfigWebhookAuthSendgrid": {
"type": "object",
"properties": {
"webhook_secret_key": {
"type": "string"
}
},
"required": [
"webhook_secret_key"
],
"additionalProperties": false,
"x-docs-type": "SENDGRID"
},
"SourceConfigWebhookAuthXero": {
"type": "object",
"properties": {
"webhook_secret_key": {
"type": "string"
}
},
"required": [
"webhook_secret_key"
],
"additionalProperties": false,
"x-docs-type": "XERO"
},
"DestinationConfigMockAPIAuthCustomSHA256HMACSignature": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"signing_secret": {
"type": "string"
}
},
"additionalProperties": false,
"x-docs-type": "CUSTOM_SIGNATURE"
},
"SourceConfigOktaAuth": {
"type": "object",
"properties": {
"webhook_secret_key": {
"type": "string"
}
},
"required": [
"webhook_secret_key"
],
"additionalProperties": false,
"nullable": true,
"x-docs-type": "Okta"
},
"SourceConfigAshbyAuth": {
"type": "object",
"properties": {
"webhook_secret_key": {
"type": "string"
}
},
"required": [
"webhook_secret_key"
],
"additionalProperties": false,
"nullable": true,
"x-docs-type": "Ashby"
},
"SourceConfigWebhookAuthEnode": {
"type": "object",
"properties": {
"webhook_secret_key": {
"type": "string"
}
},
"required": [
"webhook_secret_key"
],
"additionalProperties": false,
"x-docs-type": "ENODE"
},
"SourceTypeConfigZEROHASH": {
"type": "object",
"properties": {
"auth": {
"$ref": "#/$defs/SourceConfigZeroHashAuth"
},
"allowed_http_methods": {
"$ref": "#/$defs/SourceAllowedHTTPMethod"
},
"custom_response": {
"$ref": "#/$defs/SourceCustomResponse"
}
},
"additionalProperties": false,
"description": "The type config for ZEROHASH. Requires type to be `ZEROHASH`.",
"x-docs-type": "ZEROHASH",
"x-docs-external-url": "https://docs.zerohash.com/reference/webhook-security"
},
"SourceConfigDiscordAuth": {
"type": "object",
"properties": {
"public_key": {
"type": "string"
}
},
"required": [
"public_key"
],
"additionalProperties": false,
"nullable": true,
"x-docs-type": "Discord"
},
"SourceConfigMicrosoftGraphAuth": {
"type": "object",
"properties": {},
"additionalProperties": false,
"nullable": true,
"x-docs-type": "Microsoft Graph"
},
"SourceConfigZiftAuth": {
"type": "object",
"properties": {},
"additionalProperties": false,
"nullable": true,
"x-docs-type": "Zift"
},
"SourceTypeConfigFAUNDIT": {
"type": "object",
"properties": {
"auth": {
"$ref": "#/$defs/SourceConfigFaunditAuth"
},
"allowed_http_methods": {
"$ref": "#/$defs/SourceAllowedHTTPMethod"
},
"custom_response": {
"$ref": "#/$defs/SourceCustomResponse"
}
},
"additionalProperties": false,
"description": "The type config for FAUNDIT. Requires type to be `FAUNDIT`.",
"x-docs-type": "FAUNDIT",
"x-docs-external-url": "https://faundit.gitbook.io/faundit-api-v2/webhooks"
},
"SourceTypeConfigRING_CENTRAL": {
"type": "object",
"properties": {
"auth": {
"$ref": "#/$defs/SourceConfigRingCentralAuth"
},
"allowed_http_methods": {
"$ref": "#/$defs/SourceAllowedHTTPMethod"
},
"custom_response": {
"$ref": "#/$defs/SourceCustomResponse"
}
},
"additionalProperties": false,
"description": "The type config for RING_CENTRAL. Requires type to be `RING_CENTRAL`.",
"x-docs-type": "RING_CENTRAL",
"x-docs-external-url": "https://developer.ringcentral.com/api-docs/latest/index.html#webhooks"
},
"SourceTypeConfigNMI": {
"type": "object",
"properties": {
"auth": {
"$ref": "#/$defs/SourceConfigNMIPaymentGatewayAuth"
},
"allowed_http_methods": {
"$ref": "#/$defs/SourceAllowedHTTPMethod"
},
"custom_response": {
"$ref": "#/$defs/SourceCustomResponse"
}
},
"additionalProperties": false,
"description": "The type config for NMI. Requires type to be `NMI`.",
"x-docs-type": "NMI",
"x-docs-external-url": "https://secure.networkmerchants.com/gw/merchants/resources/integration/integration_portal.php#webhooks_setup"
},
"SourceConfigRepayAuth": {
"type": "object",
"properties": {
"webhook_secret_key": {
"type": "string"
}
},
"required": [
"webhook_secret_key"
],
"additionalProperties": false,
"nullable": true,
"x-docs-type": "Repay"
},
"SourceConfigHTTPAuthAPIKey": {
"type": "object",
"properties": {
"header_key": {
"type": "string"
},
"api_key": {
"type": "string"
}
},
"additionalProperties": false,
"x-docs-type": "API_KEY"
},
"SourceTypeConfigPRAXIS": {
"type": "object",
"properties": {
"auth": {
"$ref": "#/$defs/SourceConfigPraxisAuth"
},
"allowed_http_methods": {
"$ref": "#/$defs/SourceAllowedHTTPMethod"
},
"custom_response": {
"$ref": "#/$defs/SourceCustomResponse"
}
},
"additionalProperties": false,
"description": "The type config for PRAXIS. Requires type to be `PRAXIS`.",
"x-docs-type": "PRAXIS",
"x-docs-external-url": "https://doc.praxiscashier.com/integration_docs/latest/webhooks/validation"
},
"SourceConfigHTTPAuth": {
"type": "object",
"properties": {},
"additionalProperties": false,
"oneOf": [
{
"$ref": "#/$defs/SourceConfigHTTPAuthHMAC"
},
{
"$ref": "#/$defs/SourceConfigHTTPAuthBasicAuth"
},
{
"$ref": "#/$defs/SourceConfigHTTPAuthAPIKey"
},
{
"$ref": "#/$defs/SourceConfigHTTPAuthEmpty"
}
]
},
"SourceConfigPylonAuth": {
"type": "object",
"properties": {
"webhook_secret_key": {
"type": "string"
}
},
"required": [
"webhook_secret_key"
],
"additionalProperties": false,
"nullable": true,
"x-docs-type": "Pylon"
},
"SourceTypeConfigAWS_SNS": {
"type": "object",
"properties": {
"auth": {
"$ref": "#/$defs/SourceConfigAWSSNSAuth"
},
"allowed_http_methods": {
"$ref": "#/$defs/SourceAllowedHTTPMethod"
},
"custom_response": {
"$ref": "#/$defs/SourceCustomResponse"
}
},
"additionalProperties": false,
"description": "The type config for AWS_SNS. Requires type to be `AWS_SNS`.",
"x-docs-type": "AWS_SNS"
},
"SourceConfigNeonAuth": {
"type": "object",
"properties": {
"neon_auth_url": {
"type": "string"
}
},
"required": [
"neon_auth_url"
],
"additionalProperties": false,
"nullable": true,
"x-docs-type": "Neon"
},
"SourceTypeConfigALCHEMY": {
"type": "object",
"properties": {
"auth": {
"$ref": "#/$defs/SourceConfigAlchemyAuth"
},
"allowed_http_methods": {
"$ref": "#/$defs/SourceAllowedHTTPMethod"
},
"custom_response": {
"$ref": "#/$defs/SourceCustomResponse"
}
},
"additionalProperties": false,
"description": "The type config for ALCHEMY. Requires type to be `ALCHEMY`.",
"x-docs-type": "ALCHEMY",
"x-docs-external-url": "https://www.alchemy.com/docs/reference/notify-api-quickstart#webhook-signature--security"
},
"SourceConfigWebhookAuthZoom": {
"type": "object",
"properties": {
"webhook_secret_key": {
"type": "string"
}
},
"required": [
"webhook_secret_key"
],
"additionalProperties": false,
"x-docs-type": "ZOOM"
},
"SourceTypeConfigTYPEFORM": {
"type": "object",
"properties": {
"auth": {
"$ref": "#/$defs/SourceConfigTypeformAuth"
},
"allowed_http_methods": {
"$ref": "#/$defs/SourceAllowedHTTPMethod"
},
"custom_response": {
"$ref": "#/$defs/SourceCustomResponse"
}
},
"additionalProperties": false,
"description": "The type config for TYPEFORM. Requires type to be `TYPEFORM`.",
"x-docs-type": "TYPEFORM",
"x-docs-external-url": "https://www.typeform.com/developers/webhooks/secure-your-webhooks/"
},
"SourceTypeConfigSQUARE": {
"type": "object",
"properties": {
"auth": {
"$ref": "#/$defs/SourceConfigSquareAuth"
},
"allowed_http_methods": {
"$ref": "#/$defs/SourceAllowedHTTPMethod"
},
"custom_response": {
"$ref": "#/$defs/SourceCustomResponse"
}
},
"additionalProperties": false,
"description": "The type config for SQUARE. Requires type to be `SQUARE`.",
"x-docs-type": "SQUARE",
"x-docs-external-url": "https://developer.squareup.com/docs/webhooks/step3validate"
},
"SourceConfigPicqerAuth": {
"type": "object",
"properties": {
"webhook_secret_key": {
"type": "string"
}
},
"required": [
"webhook_secret_key"
],
"additionalProperties": false,
"nullable": true,
"x-docs-type": "Picqer"
},
"SourceConfigWebhookAuthPostmark": {
"type": "object",
"properties": {
"username": {
"type": "string"
},
"password": {
"type": "string"
}
},
"required": [
"username",
"password"
],
"additionalProperties": false,
"x-docs-type": "POSTMARK"
},
"SourceConfigOrbAuth": {
"type": "object",
"properties": {
"webhook_secret_key": {
"type": "string"
}
},
"required": [
"webhook_secret_key"
],
"additionalProperties": false,
"nullable": true,
"x-docs-type": "Orb"
},
"SourceTypeConfigEBAY": {
"type": "object",
"properties": {
"auth": {
"$ref": "#/$defs/SourceConfigEbayAuth"
},
"allowed_http_methods": {
"$ref": "#/$defs/SourceAllowedHTTPMethod"
},
"custom_response": {
"$ref": "#/$defs/SourceCustomResponse"
}
},
"additionalProperties": false,
"description": "The type config for EBAY. Requires type to be `EBAY`.",
"x-docs-type": "EBAY",
"x-docs-external-url": "https://developer.ebay.com/api-docs/commerce/notification/resources/destination/methods/createDestination"
},
"SourceConfigWebhookAuthAsana": {
"type": "object",
"properties": {
"webhook_secret_key": {
"type": "string"
}
},
"required": [
"webhook_secret_key"
],
"additionalProperties": false,
"x-docs-type": "ASANA"
},
"SourceConfigWebhookAuthPropertyFinder": {
"type": "object",
"properties": {
"webhook_secret_key": {
"type": "string"
}
},
"required": [
"webhook_secret_key"
],
"additionalProperties": false,
"x-docs-type": "PROPERTY-FINDER"
},
"SourceTypeConfigTIKTOK_SHOP": {
"type": "object",
"properties": {
"auth": {
"$ref": "#/$defs/SourceConfigTikTokShopAuth"
},
"allowed_http_methods": {
"$ref": "#/$defs/SourceAllowedHTTPMethod"
},
"custom_response": {
"$ref": "#/$defs/SourceCustomResponse"
}
},
"additionalProperties": false,
"description": "The type config for TIKTOK_SHOP. Requires type to be `TIKTOK_SHOP`.",
"x-docs-type": "TIKTOK_SHOP"
},
"SourceConfigWooCommerceAuth": {
"type": "object",
"properties": {
"webhook_secret_key": {
"type": "string"
}
},
"required": [
"webhook_secret_key"
],
"additionalProperties": false,
"nullable": true,
"x-docs-type": "WooCommerce"
},
"DestinationConfigHTTPAuthEmpty": {
"nullable": true,
"x-docs-hide": true,
"x-docs-nullable": true
},
"DestinationConfigHTTPAuthBasicAuth": {
"type": "object",
"properties": {
"username": {
"type": "string"
},
"password": {
"type": "string"
}
},
"additionalProperties": false,
"x-docs-type": "BASIC_AUTH"
},
"SourceConfigWebhookAuthSmartcar": {
"type": "object",
"properties": {
"webhook_secret_key": {
"type": "string"
}
},
"required": [
"webhook_secret_key"
],
"additionalProperties": false,
"x-docs-type": "SMARTCAR"
},
"SourceConfigWebhookAuthPipedrive": {
"type": "object",
"properties": {
"username": {
"type": "string"
},
"password": {
"type": "string"
}
},
"required": [
"username",
"password"
],
"additionalProperties": false,
"x-docs-type": "PIPEDRIVE"
},
"DestinationConfigCLIAuthCustomSHA256HMACSignature": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"signing_secret": {
"type": "string"
}
},
"additionalProperties": false,
"x-docs-type": "CUSTOM_SIGNATURE"
},
"SourceConfigWebhookAuthTelnyx": {
"type": "object",
"properties": {
"public_key": {
"type": "string"
}
},
"required": [
"public_key"
],
"additionalProperties": false,
"x-docs-type": "TELNYX"
},
"SourceConfigWebhookAuthUSPS": {
"type": "object",
"properties": {
"webhook_secret_key": {
"type": "string"
}
},
"required": [
"webhook_secret_key"
],
"additionalProperties": false,
"x-docs-type": "USPS"
},
"SourceTypeConfigSHOPIFY": {
"type": "object",
"properties": {
"auth": {
"$ref": "#/$defs/SourceConfigShopifyAuth"
},
"allowed_http_methods": {
"$ref": "#/$defs/SourceAllowedHTTPMethod"
},
"custom_response": {
"$ref": "#/$defs/SourceCustomResponse"
}
},
"additionalProperties": false,
"description": "The type config for SHOPIFY. Requires type to be `SHOPIFY`.",
"x-docs-type": "SHOPIFY",
"x-docs-external-url": "https://shopify.dev/docs/apps/build/webhooks/subscribe/https#step-2-validate-the-origin-of-your-webhook-to-ensure-its-coming-from-shopify"
},
"SourceConfigFacebookAuth": {
"type": "object",
"properties": {
"webhook_secret_key": {
"type": "string"
}
},
"required": [
"webhook_secret_key"
],
"additionalProperties": false,
"nullable": true,
"x-docs-type": "Facebook"
},
"SourceConfigMondayAuth": {
"type": "object",
"properties": {},
"additionalProperties": false,
"nullable": true,
"x-docs-type": "Monday"
},
"SourceConfigEnodeAuth": {
"type": "object",
"properties": {
"webhook_secret_key": {
"type": "string"
}
},
"required": [
"webhook_secret_key"
],
"additionalProperties": false,
"nullable": true,
"x-docs-type": "Enode"
},
"SourceTypeConfigPIPEDRIVE": {
"type": "object",
"properties": {
"auth": {
"$ref": "#/$defs/SourceConfigPipedriveAuth"
},
"allowed_http_methods": {
"$ref": "#/$defs/SourceAllowedHTTPMethod"
},
"custom_response": {
"$ref": "#/$defs/SourceCustomResponse"
}
},
"additionalProperties": false,
"description": "The type config for PIPEDRIVE. Requires type to be `PIPEDRIVE`.",
"x-docs-type": "PIPEDRIVE"
},
"SourceTypeConfigWHATSAPP": {
"type": "object",
"properties": {
"auth": {
"$ref": "#/$defs/SourceConfigWhatsAppAuth"
},
"allowed_http_methods": {
"$ref": "#/$defs/SourceAllowedHTTPMethod"
},
"custom_response": {
"$ref": "#/$defs/SourceCustomResponse"
}
},
"additionalProperties": false,
"description": "The type config for WHATSAPP. Requires type to be `WHATSAPP`.",
"x-docs-type": "WHATSAPP"
},
"DestinationConfigCLIAuthGCPServiceAccount": {
"type": "object",
"properties": {
"service_account_key": {
"type": "string"
},
"scope": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false,
"x-docs-type": "GCP_SERVICE_ACCOUNT"
},
"SourceConfigWebhookAuthExactOnline": {
"type": "object",
"properties": {
"webhook_secret_key": {
"type": "string"
}
},
"required": [
"webhook_secret_key"
],
"additionalProperties": false,
"x-docs-type": "EXACT_ONLINE"
},
"SourceConfigWebhookAuthAkeneo": {
"type": "object",
"properties": {
"webhook_secret_key": {
"type": "string"
}
},
"required": [
"webhook_secret_key"
],
"additionalProperties": false,
"x-docs-type": "AKENEO"
},
"SourceConfigCursorAuth": {
"type": "object",
"properties": {
"webhook_secret_key": {
"type": "string"
}
},
"required": [
"webhook_secret_key"
],
"additionalProperties": false,
"nullable": true,
"x-docs-type": "Cursor"
},
"SourceTypeConfigPAYPRO_GLOBAL": {
"type": "object",
"properties": {
"auth": {
"$ref": "#/$defs/SourceConfigPayProGlobalAuth"
},
"allowed_http_methods": {
"$ref": "#/$defs/SourceAllowedHTTPMethod"
},
"custom_response": {
"$ref": "#/$defs/SourceCustomResponse"
}
},
"additionalProperties": false,
"description": "The type config for PAYPRO_GLOBAL. Requires type to be `PAYPRO_GLOBAL`.",
"x-docs-type": "PAYPRO_GLOBAL",
"x-docs-external-url": "https://developers.payproglobal.com/docs/integrate-with-paypro-global/webhook-ipn/"
},
"SourceConfigSyncteraAuth": {
"type": "object",
"properties": {
"webhook_secret_key": {
"type": "string"
}
},
"required": [
"webhook_secret_key"
],
"additionalProperties": false,
"nullable": true,
"x-docs-type": "Synctera"
},
"SourceConfigWebhookAuthIntercom": {
"type": "object",
"properties": {
"webhook_secret_key": {
"type": "string"
}
},
"required": [
"webhook_secret_key"
],
"additionalProperties": false,
"x-docs-type": "INTERCOM"
},
"SourceTypeConfigUBER": {
"type": "object",
"properties": {
"auth": {
"$ref": "#/$defs/SourceConfigUberAuth"
},
"allowed_http_methods": {
"$ref": "#/$defs/SourceAllowedHTTPMethod"
},
"custom_response": {
"$ref": "#/$defs/SourceCustomResponse"
}
},
"additionalProperties": false,
"description": "The type config for UBER. Requires type to be `UBER`.",
"x-docs-type": "UBER",
"x-docs-external-url": "https://developer.uber.com/docs/eats/guides/webhooks#webhook-security"
},
"SourceConfigWebhookAuthUtila": {
"type": "object",
"properties": {
"public_key": {
"type": "string"
}
},
"required": [
"public_key"
],
"additionalProperties": false,
"x-docs-type": "UTILA"
},
"DestinationConfigHTTPAuthGCPServiceAccount": {
"type": "object",
"properties": {
"service_account_key": {
"type": "string"
},
"scope": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false,
"x-docs-type": "GCP_SERVICE_ACCOUNT"
},
"SourceConfigShopifyAuth": {
"type": "object",
"properties": {
"webhook_secret_key": {
"type": "string"
}
},
"required": [
"webhook_secret_key"
],
"additionalProperties": false,
"nullable": true,
"x-docs-type": "Shopify"
},
"SourceTypeConfigTELNYX": {
"type": "object",
"properties": {
"auth": {
"$ref": "#/$defs/SourceConfigTelnyxAuth"
},
"allowed_http_methods": {
"$ref": "#/$defs/SourceAllowedHTTPMethod"
},
"custom_response": {
"$ref": "#/$defs/SourceCustomResponse"
}
},
"additionalProperties": false,
"description": "The type config for TELNYX. Requires type to be `TELNYX`.",
"x-docs-type": "TELNYX"
},
"SourceConfigPortalAuth": {
"type": "object",
"properties": {
"webhook_secret_key": {
"type": "string"
}
},
"required": [
"webhook_secret_key"
],
"additionalProperties": false,
"nullable": true,
"x-docs-type": "Portal"
},
"SourceConfigWebhookAuthPolar": {
"type": "object",
"properties": {
"webhook_secret_key": {
"type": "string"
}
},
"required": [
"webhook_secret_key"
],
"additionalProperties": false,
"x-docs-type": "POLAR"
},
"SourceConfigWebhookAuthRevolut": {
"type": "object",
"properties": {
"webhook_secret_key": {
"type": "string"
}
},
"required": [
"webhook_secret_key"
],
"additionalProperties": false,
"x-docs-type": "REVOLUT"
},
"SourceTypeConfigTRELLO": {
"type": "object",
"properties": {
"auth": {
"$ref": "#/$defs/SourceConfigTrelloAuth"
},
"allowed_http_methods": {
"$ref": "#/$defs/SourceAllowedHTTPMethod"
},
"custom_response": {
"$ref": "#/$defs/SourceCustomResponse"
}
},
"additionalProperties": false,
"description": "The type config for TRELLO. Requires type to be `TRELLO`.",
"x-docs-type": "TRELLO",
"x-docs-external-url": "https://developer.atlassian.com/cloud/trello/guides/rest-api/webhooks/#webhook-signatures"
},
"SourceTypeConfigGITLAB": {
"type": "object",
"properties": {
"auth": {
"$ref": "#/$defs/SourceConfigGitLabAuth"
},
"allowed_http_methods": {
"$ref": "#/$defs/SourceAllowedHTTPMethod"
},
"custom_response": {
"$ref": "#/$defs/SourceCustomResponse"
}
},
"additionalProperties": false,
"description": "The type config for GITLAB. Requires type to be `GITLAB`.",
"x-docs-type": "GITLAB"
},
"SourceConfigSmileAuth": {
"type": "object",
"properties": {
"webhook_secret_key": {
"type": "string"
}
},
"required": [
"webhook_secret_key"
],
"additionalProperties": false,
"nullable": true,
"x-docs-type": "Smile"
},
"SourceConfigWebhookAuthFireflies.ai": {
"type": "object",
"properties": {
"webhook_secret_key": {
"type": "string"
}
},
"required": [
"webhook_secret_key"
],
"additionalProperties": false,
"x-docs-type": "FIREFLIES"
},
"SourceTypeConfigADYEN": {
"type": "object",
"properties": {
"auth": {
"$ref": "#/$defs/SourceConfigAdyenAuth"
},
"allowed_http_methods": {
"$ref": "#/$defs/SourceAllowedHTTPMethod"
},
"custom_response": {
"$ref": "#/$defs/SourceCustomResponse"
}
},
"additionalProperties": false,
"description": "The type config for ADYEN. Requires type to be `ADYEN`.",
"x-docs-type": "ADYEN",
"x-docs-external-url": "https://docs.adyen.com/development-resources/webhooks/verify-hmac-signatures/"
},
"SourceTypeConfigTALLY": {
"type": "object",
"properties": {
"auth": {
"$ref": "#/$defs/SourceConfigTallyAuth"
},
"allowed_http_methods": {
"$ref": "#/$defs/SourceAllowedHTTPMethod"
},
"custom_response": {
"$ref": "#/$defs/SourceCustomResponse"
}
},
"additionalProperties": false,
"description": "The type config for TALLY. Requires type to be `TALLY`.",
"x-docs-type": "TALLY",
"x-docs-external-url": "https://tally.so/help/webhooks"
},
"SourceConfigWebhookAuthSvix": {
"type": "object",
"properties": {
"webhook_secret_key": {
"type": "string"
}
},
"required": [
"webhook_secret_key"
],
"additionalProperties": false,
"x-docs-type": "SVIX"
},
"DestinationConfigCLIAuth": {
"type": "object",
"properties": {},
"additionalProperties": false,
"oneOf": [
{
"$ref": "#/$defs/DestinationConfigCLIAuthHookdeckSignatureDefault"
},
{
"$ref": "#/$defs/DestinationConfigCLIAuthCustomSHA256HMACSignature"
},
{
"$ref": "#/$defs/DestinationConfigCLIAuthBasicAuth"
},
{
"$ref": "#/$defs/DestinationConfigCLIAuthAPIKey"
},
{
"$ref": "#/$defs/DestinationConfigCLIAuthBearerToken"
},
{
"$ref": "#/$defs/DestinationConfigCLIAuthOAuth2ClientCredentials"
},
{
"$ref": "#/$defs/DestinationConfigCLIAuthOAuth2AuthorizationCode"
},
{
"$ref": "#/$defs/DestinationConfigCLIAuthAWSSignature"
},
{
"$ref": "#/$defs/DestinationConfigCLIAuthGCPServiceAccount"
},
{
"$ref": "#/$defs/DestinationConfigCLIAuthEmpty"
}
]
},
"SourceTypeConfigASANA": {
"type": "object",
"properties": {
"auth": {
"$ref": "#/$defs/SourceConfigAsanaAuth"
},
"allowed_http_methods": {
"$ref": "#/$defs/SourceAllowedHTTPMethod"
},
"custom_response": {
"$ref": "#/$defs/SourceCustomResponse"
}
},
"additionalProperties": false,
"description": "The type config for ASANA. Requires type to be `ASANA`.",
"x-docs-type": "ASANA",
"x-docs-external-url": "https://developers.asana.com/docs/webhooks-guide#security"
},
"FilterRule": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"filter"
],
"description": "A filter rule must be of type `filter`"
},
"headers": {
"$ref": "#/$defs/FilterRuleProperty"
},
"body": {
"$ref": "#/$defs/FilterRuleProperty"
},
"query": {
"$ref": "#/$defs/FilterRuleProperty"
},
"path": {
"$ref": "#/$defs/FilterRuleProperty"
}
},
"required": [
"type"
],
"additionalProperties": false
},
"SourceTypeConfigASCEND": {
"type": "object",
# --- truncated at 32 KB (221 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/hookdeck/refs/heads/main/json-schema/hookdeck-connection-schema.json