Hookdeck · Schema
Hookdeck Source
Associated [Source](#source-object) object
WebhooksEvent GatewaysGatewaysEventsEvent InfrastructureEvent-DrivenMessagingQueuesRetriesTransformationsObservability
Properties
| Name | Type | Description |
|---|---|---|
| id | string | ID of the source |
| name | string | Name for the source |
| description | string | Description of the source |
| team_id | string | ID of the project |
| url | string | A unique URL that must be supplied to your webhook's provider |
| type | string | Type of the source |
| authenticated | boolean | Whether the source is authenticated |
| config | object | |
| disabled_at | string | Date the source was disabled |
| updated_at | string | Date the source was last updated |
| created_at | string | Date the source 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-source-schema.json",
"title": "Hookdeck Source",
"description": "Associated [Source](#source-object) object",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the source"
},
"name": {
"type": "string",
"description": "Name for the source"
},
"description": {
"type": "string",
"nullable": true,
"description": "Description of the source"
},
"team_id": {
"type": "string",
"description": "ID of the project"
},
"url": {
"type": "string",
"description": "A unique URL that must be supplied to your webhook's provider",
"format": "URL"
},
"type": {
"type": "string",
"enum": [
"AIPRISE",
"ALCHEMY",
"DOCUSIGN",
"INTERCOM",
"PUBLISH_API",
"WEBHOOK",
"HTTP",
"MANAGED",
"HOOKDECK_OUTPOST",
"SANITY",
"BIGCOMMERCE",
"CLAUDE",
"OPENAI",
"POLAR",
"BRIDGE_XYZ",
"BRIDGE_API",
"CHARGEBEE_BILLING",
"CHAINDOTS",
"CLOUDSIGNAL",
"COINBASE",
"COURIER",
"CURSOR",
"MERAKI",
"MICROSOFT_GRAPH",
"MICROSOFT_SHAREPOINT",
"FIREBLOCKS",
"FRONTAPP",
"ZOOM",
"TWITTER",
"RECHARGE",
"RECURLY",
"REVOLUT",
"RING_CENTRAL",
"STRIPE",
"PROPERTY-FINDER",
"QUOTER",
"SHOPIFY",
"TWILIO",
"GITHUB",
"POSTMARK",
"TALLY",
"TYPEFORM",
"PICQER",
"XERO",
"SVIX",
"RESEND",
"GEMINI",
"ADYEN",
"AKENEO",
"GITLAB",
"WOOCOMMERCE",
"OKTA",
"OURA",
"COMMERCELAYER",
"HUBSPOT",
"MAILGUN",
"PERSONA",
"PIPEDRIVE",
"SENDGRID",
"WORKOS",
"SYNCTERA",
"AWS_SNS",
"THREE_D_EYE",
"TWITCH",
"ENODE",
"FAUNDIT",
"FAVRO",
"LINEAR",
"SHIPBOB",
"SHIPHERO",
"SHOPLINE",
"WIX",
"NMI",
"NEON",
"ORB",
"PYLON",
"RAZORPAY",
"REPAY",
"SQUARE",
"SOLIDGATE",
"TRELLO",
"EBAY",
"TELNYX",
"DISCORD",
"TOKENIO",
"FISERV",
"FUSIONAUTH",
"BONDSMITH",
"VERCEL_LOG_DRAINS",
"VERCEL",
"TEBEX",
"SLACK",
"SMARTCAR",
"MAILCHIMP",
"NUVEMSHOP",
"PADDLE",
"PAYPAL",
"PAYMOB",
"PAYSTACK",
"SCRAPFLY",
"PORTAL",
"TREEZOR",
"PRAXIS",
"CUSTOMERIO",
"EXACT_ONLINE",
"FACEBOOK",
"WHATSAPP",
"REPLICATE",
"TIKTOK",
"TIKTOK_SHOP",
"AIRWALLEX",
"ASCEND",
"ALIPAY",
"ZENDESK",
"UPOLLO",
"SMILE",
"NYLAS",
"CLIO",
"GOCARDLESS",
"LINKEDIN",
"LITHIC",
"STRAVA",
"UTILA",
"MONDAY",
"GREENDOT",
"ZEROHASH",
"ZIFT",
"ETHOCA",
"AIRTABLE",
"ASANA",
"ASHBY",
"FASTSPRING",
"PAYPRO_GLOBAL",
"USPS",
"WALMART",
"FIREFLIES",
"FLEXPORT",
"UBER",
"WECHAT",
"CIRCLE"
],
"description": "Type of the source"
},
"authenticated": {
"type": "boolean",
"description": "Whether the source is authenticated"
},
"config": {
"$ref": "#/$defs/SourceConfig"
},
"disabled_at": {
"type": "string",
"format": "date-time",
"nullable": true,
"description": "Date the source was disabled"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Date the source was last updated"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Date the source was created"
}
},
"required": [
"id",
"name",
"team_id",
"url",
"type",
"authenticated",
"disabled_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"
},
"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"
},
"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"
},
"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"
}
]
},
"SourceConfigHTTPAuthAPIKey": {
"type": "object",
"properties": {
"header_key": {
"type": "string"
},
"api_key": {
"type": "string"
}
},
"additionalProperties": false,
"x-docs-type": "API_KEY"
},
"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"
},
"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"
},
"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"
},
"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"
},
"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"
},
"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"
},
"SourceTypeConfigASCEND": {
"type": "object",
"properties": {
"auth": {
"$ref": "#/$defs/SourceConfigAscendAuth"
},
"allowed_http_methods": {
"$ref": "#/$defs/SourceAllowedHTTPMethod"
},
"custom_response": {
"$ref": "#/$defs/SourceCustomResponse"
}
},
"additionalProperties": false,
"description": "The type config for ASCEND. Requires type to be `ASCEND`.",
"x-docs-type": "ASCEND",
"x-docs-external-url": "https://developers.useascend.com/docs/webhooks"
},
"SourceConfigPaymobAuth": {
"type": "object",
"properties": {
"webhook_secret_key": {
"type": "string"
}
},
"required": [
"webhook_secret_key"
],
"additionalProperties": false,
"nullable": true,
"x-docs-type": "Paymob"
},
"SourceCustomResponseContentType": {
"type": "string",
"enum": [
"json",
"text",
"xml"
],
"description": "Content type of the custom response"
},
"SourceTypeConfigGEMINI": {
"type": "object",
"properties": {
"auth": {
"$ref": "#/$defs/SourceConfigGoogleGeminiAuth"
},
"allowed_http_methods": {
"$ref": "#/$defs/SourceAllowedHTTPMethod"
},
"custom_response": {
"$ref": "#/$defs/SourceCustomResponse"
}
},
"additionalProperties": false,
"description": "The type config for GEMINI. Requires type to be `GEMINI`.",
"x-docs-type": "GEMINI",
"x-docs-external-url": "https://ai.google.dev/gemini-api/docs/webhooks#handle-webhook-requests"
},
"SourceConfigWebhookAuthGitHub": {
"type": "object",
"properties": {
"webhook_secret_key": {
"type": "string"
}
},
"required": [
"webhook_secret_key"
],
"additionalProperties": false,
"x-docs-type": "GITHUB"
},
"SourceConfigAkeneoAuth": {
"type": "object",
"properties": {
"webhook_secret_key": {
"type": "string"
}
},
"required": [
"webhook_secret_key"
],
"additionalProperties": false,
"nullable": true,
"x-docs-type": "Akeneo"
},
"SourceConfigGitHubAuth": {
"type": "object",
"pr
# --- truncated at 32 KB (193 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/hookdeck/refs/heads/main/json-schema/hookdeck-source-schema.json