{ "$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", "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", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "GitHub" }, "SourceConfigCloudSignalAuth": { "type": "object", "properties": { "api_key": { "type": "string" } }, "required": [ "api_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Cloud Signal" }, "DeduplicateRule": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "deduplicate" ], "description": "A deduplicate rule must be of type `deduplicate`" }, "window": { "type": "integer", "minimum": 1000, "maximum": 3600000, "description": "Time window in milliseconds for deduplicate" }, "include_fields": { "type": "array", "items": { "type": "string" }, "description": "Fields to include when generating deduplicate key. Supports root fields (e.g., \"headers\"), dot notation (e.g., \"body.user.id\"), array wildcards (e.g., \"body.items[*].sku\"), and array indices (e.g., \"body.items[0].name\"). Array notation must be followed by a property name." }, "exclude_fields": { "type": "array", "items": { "type": "string" }, "description": "Fields to exclude when generating deduplicate key. Supports root fields (e.g., \"headers\"), dot notation (e.g., \"body.user.id\"), array wildcards (e.g., \"body.items[*].sku\"), and array indices (e.g., \"body.items[0].name\"). Array notation must be followed by a property name." } }, "required": [ "type", "window" ], "additionalProperties": false }, "SourceConfigWebhookAuth3dEye": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "THREE_D_EYE" }, "SourceConfigGreenDotAuth": { "type": "object", "properties": { "username": { "type": "string" }, "password": { "type": "string" } }, "required": [ "username", "password" ], "additionalProperties": false, "nullable": true, "x-docs-type": "GreenDot" }, "SourceConfigWebhookAuthUpollo": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "UPOLLO" }, "SourceConfigChargebeeBillingAuth": { "type": "object", "properties": { "username": { "type": "string" }, "password": { "type": "string" } }, "required": [ "username", "password" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Chargebee Billing" }, "SourceConfigWebhookAuthWorkOS": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "WORKOS" }, "SourceConfigFaunditAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Faundit" }, "SourceTypeConfigOPENAI": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigOpenAIAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for OPENAI. Requires type to be `OPENAI`.", "x-docs-type": "OPENAI" }, "SourceTypeConfigPICQER": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigPicqerAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for PICQER. Requires type to be `PICQER`.", "x-docs-type": "PICQER", "x-docs-external-url": "https://picqer.com/en/api/webhooks#validating-webhooks" }, "SourceTypeConfigALIPAY": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigAlipayAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for ALIPAY. Requires type to be `ALIPAY`.", "x-docs-type": "ALIPAY", "x-docs-external-url": "https://docs.alipayplus.com/alipayplus/alipayplus/api_acq_tile/signature" }, "SourceConfigWebhookAuthAirwallex": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "AIRWALLEX" }, "DestinationConfigHTTPAuthOAuth2ClientCredentials": { "type": "object", "properties": { "auth_server": { "type": "string" }, "client_id": { "type": "string" }, "client_secret": { "type": "string" }, "scope": { "type": "string" }, "authentication_type": { "type": "string", "enum": [ "basic", "bearer", "x-www-form-urlencoded" ] } }, "additionalProperties": false, "x-docs-type": "OAUTH2_CLIENT_CREDENTIALS" }, "SourceTypeConfigBRIDGE_API": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigBridgeAPIAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for BRIDGE_API. Requires type to be `BRIDGE_API`.", "x-docs-type": "BRIDGE_API", "x-docs-external-url": "https://docs.bridgeapi.io/docs/secure-your-webhooks" }, "SourceConfigWebhookAuthX": { "type": "object", "properties": { "api_key": { "type": "string" } }, "required": [ "api_key" ], "additionalProperties": false, "x-docs-type": "TWITTER" }, "SourceTypeConfigORB": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigOrbAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for ORB. Requires type to be `ORB`.", "x-docs-type": "ORB", "x-docs-external-url": "https://docs.withorb.com/guides/integrations-and-exports/webhooks#webhooks-verification" }, "RetryRule": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "retry" ], "description": "A retry rule must be of type `retry`" }, "strategy": { "$ref": "#/$defs/RetryStrategy" }, "interval": { "type": "integer", "nullable": true, "description": "Time in MS between each retry" }, "count": { "type": "integer", "nullable": true, "description": "Maximum number of retries to attempt" }, "response_status_codes": { "type": "array", "items": { "type": "string", "pattern": "^(?:([2-5]\\d{2})-([2-5]\\d{2})|([><=]{1,2})([2-5]\\d{2})|!?([2-5]\\d{2}))$" }, "minItems": 1, "maxItems": 10, "nullable": true, "description": "HTTP codes to retry on. Accepts: range expressions (e.g., \"400-499\", \">400\"), specific codes (e.g., 404), and exclusions (e.g., \"!401\"). Example: [\"500-599\", \">400\", 404, \"!401\"]" } }, "required": [ "type", "strategy" ], "additionalProperties": false }, "SourceConfigWebhookAuthShipHero": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "SHIPHERO" }, "SourceConfigFiservAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" }, "store_name": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Fiserv" }, "SourceConfigWebhookAuthHMAC": { "type": "object", "properties": { "algorithm": { "type": "string", "enum": [ "sha1", "sha256", "sha512", "md5" ] }, "encoding": { "type": "string", "enum": [ "base64", "base64url", "hex" ] }, "header_key": { "type": "string" }, "webhook_secret_key": { "type": "string" } }, "required": [ "algorithm", "encoding", "header_key", "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "HMAC" }, "SourceConfigTikTokShopAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" }, "app_key": { "type": "string" } }, "required": [ "webhook_secret_key", "app_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "TikTok Shop" }, "SourceConfigWebhookAuthSmile": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "SMILE" }, "SourceConfigCircleAuth": { "type": "object", "properties": { "api_key": { "type": "string" } }, "required": [ "api_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Circle" }, "SourceConfigSanityAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Sanity" }, "SourceConfigWebhookAuthFastSpring": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "FASTSPRING" }, "SourceConfigWebhookAuthSquare": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "SQUARE" }, "SourceTypeConfigHTTP": { "type": "object", "properties": { "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" }, "auth_type": { "type": "string", "enum": [ "HMAC", "BASIC_AUTH", "API_KEY" ], "nullable": true }, "auth": { "$ref": "#/$defs/SourceConfigHTTPAuth" } }, "additionalProperties": false, "description": "The type config for HTTP. Requires type to be `HTTP`.", "x-docs-type": "HTTP" }, "DelayRule": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "delay" ], "description": "A delay rule must be of type `delay`" }, "delay": { "type": "integer", "description": "Delay to introduce in MS" } }, "required": [ "type", "delay" ], "additionalProperties": false }, "SourceTypeConfigCLIO": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigClioAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for CLIO. Requires type to be `CLIO`.", "x-docs-type": "CLIO", "x-docs-external-url": "https://docs.developers.clio.com/api-reference/#tag/Webhooks/Webhook-Security" }, "SourceConfigAlchemyAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Alchemy" }, "SourceConfigShoplineAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Shopline" }, "SourceConfigWebhookAuthMeraki": { "type": "object", "properties": { "api_key": { "type": "string" } }, "required": [ "api_key" ], "additionalProperties": false, "x-docs-type": "MERAKI" }, "SourceTypeConfigMAILGUN": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigMailgunAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for MAILGUN. Requires type to be `MAILGUN`.", "x-docs-type": "MAILGUN", "x-docs-external-url": "https://documentation.mailgun.com/docs/mailgun/user-manual/tracking-messages/#webhooks" }, "SourceConfigWebhookAuthWeChatPay": { "type": "object", "properties": { "public_key": { "type": "string" } }, "required": [ "public_key" ], "additionalProperties": false, "x-docs-type": "WECHAT" }, "SourceConfigRingCentralAuth": { "type": "object", "properties": { "token": { "type": "string" } }, "required": [ "token" ], "additionalProperties": false, "nullable": true, "x-docs-type": "RingCentral" }, "SourceConfigZeroHashAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "ZeroHash" }, "DestinationConfigCLIAuthBasicAuth": { "type": "object", "properties": { "username": { "type": "string" }, "password": { "type": "string" } }, "additionalProperties": false, "x-docs-type": "BASIC_AUTH" }, "SourceConfigWebhookAuthTrello": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "TRELLO" }, "SourceConfigFireblocksAuth": { "type": "object", "properties": { "environment": { "type": "string", "enum": [ "US_PRODUCTION", "EU", "EU2", "SANDBOX" ] } }, "required": [ "environment" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Fireblocks" }, "SourceConfigWebhookAuthPaddle": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "PADDLE" }, "SourceConfigWebhookAuthSolidgate": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "SOLIDGATE" }, "SourceConfigWebhookAuthRecharge": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "RECHARGE" }, "SourceConfigScrapflyAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Scrapfly" }, "SourceTypeConfigVERCEL": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigVercelWebhooksAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for VERCEL. Requires type to be `VERCEL`.", "x-docs-type": "VERCEL", "x-docs-external-url": "https://vercel.com/docs/observability/webhooks-overview/webhooks-api#securing-webhooks" }, "SourceConfigGoCardlessAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "GoCardless" }, "SourceConfigPropertyFinderAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Property Finder" }, "SourceTypeConfigPUBLISH_API": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigHookdeckPublishAPIAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for PUBLISH_API. Requires type to be `PUBLISH_API`.", "x-docs-type": "PUBLISH_API" }, "SourceConfigWebhookAuthGitLab": { "type": "object", "properties": { "api_key": { "type": "string" } }, "required": [ "api_key" ], "additionalProperties": false, "x-docs-type": "GITLAB" }, "SourceTypeConfigENODE": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigEnodeAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for ENODE. Requires type to be `ENODE`.", "x-docs-type": "ENODE", "x-docs-external-url": "https://developers.enode.com/docs/webhooks" }, "DestinationConfigMockAPIAuth": { "type": "object", "properties": {}, "additionalProperties": false, "oneOf": [ { "$ref": "#/$defs/DestinationConfigMockAPIAuthHookdeckSignatureDefault" }, { "$ref": "#/$defs/DestinationConfigMockAPIAuthCustomSHA256HMACSignature" }, { "$ref": "#/$defs/DestinationConfigMockAPIAuthBasicAuth" }, { "$ref": "#/$defs/DestinationConfigMockAPIAuthAPIKey" }, { "$ref": "#/$defs/DestinationConfigMockAPIAuthBearerToken" }, { "$ref": "#/$defs/DestinationConfigMockAPIAuthOAuth2ClientCredentials" }, { "$ref": "#/$defs/DestinationConfigMockAPIAuthOAuth2AuthorizationCode" }, { "$ref": "#/$defs/DestinationConfigMockAPIAuthAWSSignature" }, { "$ref": "#/$defs/DestinationConfigMockAPIAuthGCPServiceAccount" }, { "$ref": "#/$defs/DestinationConfigMockAPIAuthEmpty" } ] }, "SourceConfigXeroAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Xero" }, "TransformRule": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "transform" ], "description": "A transformation rule must be of type `transform`" }, "transformation_id": { "type": "string", "nullable": true, "description": "ID of the attached transformation object. Optional input, always set once the rule is defined" }, "transformation": { "type": "object", "properties": { "name": { "type": "string", "description": "The unique name of the transformation" }, "code": { "type": "string", "description": "A string representation of your JavaScript (ES6) code to run" }, "env": { "type": "object", "properties": {}, "additionalProperties": { "type": "string" }, "nullable": true, "description": "A key-value object of environment variables to encrypt and expose to your transformation code" } }, "required": [ "name", "code" ], "additionalProperties": false, "description": "You can optionally define a new transformation while creating a transform rule" } }, "required": [ "type" ], "additionalProperties": false }, "SourceConfigWebhookAuthCourier": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "COURIER" }, "DestinationTypeConfigMOCK_API": { "type": "object", "properties": { "rate_limit": { "type": "number", "format": "float", "nullable": true }, "rate_limit_period": { "type": "string", "enum": [ "second", "minute", "hour", "concurrent" ], "nullable": true }, "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/DestinationConfigMockAPIAuth" } }, "additionalProperties": false, "description": "The type config for MOCK_API. Requires type to be `MOCK_API`.", "x-docs-type": "MOCK_API" }, "SourceConfigWebhookAuthAirtable": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "AIRTABLE" }, "DestinationConfigCLIAuthAPIKey": { "type": "object", "properties": { "key": { "type": "string" }, "api_key": { "type": "string" }, "to": { "type": "string", "enum": [ "header", "query" ] } }, "additionalProperties": false, "x-docs-type": "API_KEY" }, "SourceConfigWebhookAuthPersona": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "PERSONA" }, "SourceConfigWebhookAuthBigCommerce": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "BIGCOMMERCE" }, "SourceConfigHTTPAuthBasicAuth": { "type": "object", "properties": { "username": { "type": "string" }, "password": { "type": "string" } }, "additionalProperties": false, "x-docs-type": "BASIC_AUTH" }, "SourceTypeConfigRECURLY": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigRecurlyAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for RECURLY. Requires type to be `RECURLY`.", "x-docs-type": "RECURLY", "x-docs-external-url": "https://docs.recurly.com/recurly-subscriptions/docs/signature-verification" }, "SourceConfigWebhookAuthReplicate": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "REPLICATE" }, "DestinationConfigMockAPIAuthEmpty": { "nullable": true, "x-docs-hide": true, "x-docs-nullable": true }, "FilterRuleProperty": { "anyOf": [ { "type": "string", "nullable": true }, { "type": "number", "format": "float", "nullable": true }, { "type": "boolean", "nullable": true }, { "type": "object", "properties": {}, "additionalProperties": true, "nullable": true } ], "nullable": true, "description": "JSON using our filter syntax to filter on request headers", "x-docs-type": "JSON", "x-docs-force-simple-type": true }, "SourceConfigSlackAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Slack" }, "SourceConfigWebhookAuthFiserv": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" }, "store_name": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "FISERV" }, "SourceConfigStravaAuth": { "type": "object", "properties": {}, "additionalProperties": false, "nullable": true, "x-docs-type": "Strava" }, "SourceTypeConfigINTERCOM": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigIntercomAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for INTERCOM. Requires type to be `INTERCOM`.", "x-docs-type": "INTERCOM", "x-docs-external-url": "https://developers.intercom.com/docs/references/webhooks/webhook-models#signed-notifications" }, "SourceConfigVercelWebhooksAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Vercel Webhooks" }, "SourceCustomResponse": { "type": "object", "properties": { "content_type": { "$ref": "#/$defs/SourceCustomResponseContentType" }, "body": { "type": "string", "maxLength": 1000, "description": "Body of the custom response" } }, "required": [ "content_type", "body" ], "additionalProperties": false, "nullable": true, "description": "Custom response object" }, "SourceConfigWebhookAuthPaymob": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "PAYMOB" }, "SourceConfigEbayAuth": { "type": "object", "properties": { "environment": { "type": "string", "enum": [ "PRODUCTION", "SANDBOX" ] }, "dev_id": { "type": "string" }, "client_id": { "type": "string" }, "client_secret": { "type": "string" }, "verification_token": { "type": "string" } }, "required": [ "environment", "dev_id", "client_id", "client_secret", "verification_token" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Ebay" }, "SourceConfigWebhookAuthFlexport": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "FLEXPORT" }, "SourceTypeConfigNYLAS": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigNylasAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for NYLAS. Requires type to be `NYLAS`.", "x-docs-type": "NYLAS", "x-docs-external-url": "https://developer.nylas.com/docs/v3/getting-started/webhooks/" }, "SourceTypeConfigMAILCHIMP": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigMailchimpAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for MAILCHIMP. Requires type to be `MAILCHIMP`.", "x-docs-type": "MAILCHIMP" }, "SourceConfigAipriseAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Aiprise" }, "DestinationConfigHTTPAuth": { "type": "object", "properties": {}, "additionalProperties": false, "oneOf": [ { "$ref": "#/$defs/DestinationConfigHTTPAuthHookdeckSignatureDefault" }, { "$ref": "#/$defs/DestinationConfigHTTPAuthCustomSHA256HMACSignature" }, { "$ref": "#/$defs/DestinationConfigHTTPAuthBasicAuth" }, { "$ref": "#/$defs/DestinationConfigHTTPAuthAPIKey" }, { "$ref": "#/$defs/DestinationConfigHTTPAuthBearerToken" }, { "$ref": "#/$defs/DestinationConfigHTTPAuthOAuth2ClientCredentials" }, { "$ref": "#/$defs/DestinationConfigHTTPAuthOAuth2AuthorizationCode" }, { "$ref": "#/$defs/DestinationConfigHTTPAuthAWSSignature" }, { "$ref": "#/$defs/DestinationConfigHTTPAuthGCPServiceAccount" }, { "$ref": "#/$defs/DestinationConfigHTTPAuthEmpty" } ] }, "SourceConfigWebhookAuthLithic": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "LITHIC" }, "SourceConfigWebhookAuthWooCommerce": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "WOOCOMMERCE" }, "SourceConfigWebhookAuthEbay": { "type": "object", "properties": { "environment": { "type": "string", "enum": [ "PRODUCTION", "SANDBOX" ] }, "dev_id": { "type": "string" }, "client_id": { "type": "string" }, "client_secret": { "type": "string" }, "verification_token": { "type": "string" } }, "required": [ "environment", "dev_id", "client_id", "client_secret", "verification_token" ], "additionalProperties": false, "x-docs-type": "EBAY" }, "DestinationConfigMockAPIAuthOAuth2ClientCredentials": { "type": "object", "properties": { "auth_server": { "type": "string" }, "client_id": { "type": "string" }, "client_secret": { "type": "string" }, "scope": { "type": "string" }, "authentication_type": { "type": "string", "enum": [ "basic", "bearer", "x-www-form-urlencoded" ] } }, "additionalProperties": false, "x-docs-type": "OAUTH2_CLIENT_CREDENTIALS" }, "SourceTypeConfigSHOPLINE": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigShoplineAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for SHOPLINE. Requires type to be `SHOPLINE`.", "x-docs-type": "SHOPLINE", "x-docs-external-url": "https://developer.shopline.com/docsv2/ec20/3cv5d7wpfgr6a8z5/wf8em731s7f8c3ut?version=v20240301#signature-verification" }, "DestinationConfigHTTPAuthCustomSHA256HMACSignature": { "type": "object", "properties": { "key": { "type": "string" }, "signing_secret": { "type": "string" } }, "additionalProperties": false, "x-docs-type": "CUSTOM_SIGNATURE" }, "SourceConfigQuoterAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Quoter" }, "SourceConfigRazorpayAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Razorpay" }, "SourceTypeConfigSHIPBOB": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigShipBobAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for SHIPBOB. Requires type to be `SHIPBOB`.", "x-docs-type": "SHIPBOB", "x-docs-external-url": "https://developer.shipbob.com/2026-01/webhooks#verifying-signatures" }, "SourceConfigWebhookAuthSanity": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "SANITY" }, "SourceTypeConfigOKTA": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigOktaAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for OKTA. Requires type to be `OKTA`.", "x-docs-type": "OKTA" }, "SourceConfigUberAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Uber" }, "SourceConfigResendAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Resend" }, "SourceTypeConfigETHOCA": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigEthocaAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for ETHOCA. Requires type to be `ETHOCA`.", "x-docs-type": "ETHOCA" }, "SourceConfigOuraAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Oura" }, "SourceConfigLithicAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Lithic" }, "SourceConfigPraxisAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Praxis" }, "SourceTypeConfigWALMART": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigWalmartAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for WALMART. Requires type to be `WALMART`.", "x-docs-type": "WALMART", "x-docs-external-url": "https://developer.walmart.com/us-marketplace/docs/security-and-authenticity" }, "SourceConfigStripeAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Stripe" }, "DestinationConfigCLIAuthBearerToken": { "type": "object", "properties": { "token": { "type": "string" } }, "additionalProperties": false, "x-docs-type": "BEARER_TOKEN" }, "SourceConfigTokenIOAuth": { "type": "object", "properties": { "public_key": { "type": "string" } }, "required": [ "public_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "TokenIO" }, "SourceConfigBigCommerceAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "BigCommerce" }, "SourceConfigWebhookAuthFaundit": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "FAUNDIT" }, "SourceConfigOpenAIAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "OpenAI" }, "DestinationConfigMockAPIAuthHookdeckSignatureDefault": { "type": "object", "properties": {}, "additionalProperties": false, "x-docs-type": "HOOKDECK_SIGNATURE" }, "SourceConfigShipHeroAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "ShipHero" }, "SourceConfigShipBobAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "ShipBob" }, "SourceConfigWebhookAuthRecurly": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "RECURLY" }, "SourceTypeConfigLITHIC": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigLithicAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for LITHIC. Requires type to be `LITHIC`.", "x-docs-type": "LITHIC", "x-docs-external-url": "https://docs.lithic.com/docs/events-api#verifying-webhooks" }, "SourceTypeConfigREPAY": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigRepayAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for REPAY. Requires type to be `REPAY`.", "x-docs-type": "REPAY" }, "SourceConfigWebhookAuthFireblocks": { "type": "object", "properties": { "environment": { "type": "string", "enum": [ "US_PRODUCTION", "EU", "EU2", "SANDBOX" ] } }, "required": [ "environment" ], "additionalProperties": false, "x-docs-type": "FIREBLOCKS" }, "SourceConfigWebhookAuthCursor": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "CURSOR" }, "SourceConfigWebhookAuthQuoter": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "QUOTER" }, "SourceConfigSolidgateAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Solidgate" }, "SourceTypeConfigGREENDOT": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigGreenDotAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for GREENDOT. Requires type to be `GREENDOT`.", "x-docs-type": "GREENDOT", "x-docs-external-url": "https://developer.greendot.com/embedded-finance/docs/webhooks-overview" }, "SourceConfigWebhookAuthGoogleGemini": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "GEMINI" }, "DestinationConfigMockAPIAuthBearerToken": { "type": "object", "properties": { "token": { "type": "string" } }, "additionalProperties": false, "x-docs-type": "BEARER_TOKEN" }, "SourceConfigWebhookAuthPortal": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "PORTAL" }, "SourceTypeConfigFIREBLOCKS": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigFireblocksAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for FIREBLOCKS. Requires type to be `FIREBLOCKS`.", "x-docs-type": "FIREBLOCKS", "x-docs-external-url": "https://developers.fireblocks.com/reference/validating-webhooks" }, "SourceTypeConfigCOINBASE": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigCoinbaseAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for COINBASE. Requires type to be `COINBASE`.", "x-docs-type": "COINBASE", "x-docs-external-url": "https://docs.cdp.coinbase.com/data/webhooks/verify-signatures" }, "SourceTypeConfigCOMMERCELAYER": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigCommerceLayerAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for COMMERCELAYER. Requires type to be `COMMERCELAYER`.", "x-docs-type": "COMMERCELAYER", "x-docs-external-url": "https://docs.commercelayer.io/core/callbacks-security" }, "SourceConfigWebhookAuthPicqer": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "PICQER" }, "SourceConfigWebhookAuthUber": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "UBER" }, "SourceConfigWebhookAuthNylas": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "NYLAS" }, "SourceConfigWebhookAuthVercelDrains": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "additionalProperties": false, "x-docs-type": "VERCEL_LOG_DRAINS" }, "SourceTypeConfigFLEXPORT": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigFlexportAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for FLEXPORT. Requires type to be `FLEXPORT`.", "x-docs-type": "FLEXPORT", "x-docs-external-url": "https://apidocs.flexport.com/v2/tag/Webhook-Endpoints/" }, "SourceConfigDocuSignAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "DocuSign" }, "SourceConfigIntercomAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Intercom" }, "SourceConfigFavroAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Favro" }, "SourceConfigWebhookAuthAlchemy": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "ALCHEMY" }, "SourceTypeConfigBIGCOMMERCE": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigBigCommerceAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for BIGCOMMERCE. Requires type to be `BIGCOMMERCE`.", "x-docs-type": "BIGCOMMERCE" }, "SourceConfigMailgunAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Mailgun" }, "SourceTypeConfigPAYSTACK": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigPaystackAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for PAYSTACK. Requires type to be `PAYSTACK`.", "x-docs-type": "PAYSTACK", "x-docs-external-url": "https://paystack.com/docs/payments/webhooks/#verify-event-origin" }, "SourceTypeConfigOURA": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigOuraAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for OURA. Requires type to be `OURA`.", "x-docs-type": "OURA", "x-docs-external-url": "https://cloud.ouraring.com/v2/docs#section/Security" }, "SourceConfigLinkedInAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "LinkedIn" }, "SourceConfigExactOnlineAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Exact Online" }, "DestinationConfigMockAPIAuthGCPServiceAccount": { "type": "object", "properties": { "service_account_key": { "type": "string" }, "scope": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-docs-type": "GCP_SERVICE_ACCOUNT" }, "SourceConfigWebhookAuthTikTok": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "TIKTOK" }, "SourceConfigFrontAppAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "FrontApp" }, "SourceConfigZendeskAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Zendesk" }, "SourceConfigPayProGlobalAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "PayPro Global" }, "SourceTypeConfigSMILE": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigSmileAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for SMILE. Requires type to be `SMILE`.", "x-docs-type": "SMILE", "x-docs-external-url": "https://docs.getsmileapi.com/reference/webhooks#validating-payloads" }, "SourceConfigWalmartAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Walmart" }, "SourceTypeConfigSTRIPE": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigStripeAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for STRIPE. Requires type to be `STRIPE`.", "x-docs-type": "STRIPE", "x-docs-external-url": "https://docs.stripe.com/webhooks?verify=verify-manually" }, "SourceConfigWebhookAuthDocuSign": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "DOCUSIGN" }, "SourceConfigMicrosoftSharePointAuth": { "type": "object", "properties": {}, "additionalProperties": false, "nullable": true, "x-docs-type": "Microsoft SharePoint" }, "SourceTypeConfigWIX": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigWixAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for WIX. Requires type to be `WIX`.", "x-docs-type": "WIX", "x-docs-external-url": "https://dev.wix.com/docs/build-apps/build-your-app/authentication/verify-wix-requests" }, "SourceConfig": { "type": "object", "properties": {}, "additionalProperties": false, "oneOf": [ { "$ref": "#/$defs/SourceTypeConfigAIPRISE" }, { "$ref": "#/$defs/SourceTypeConfigALCHEMY" }, { "$ref": "#/$defs/SourceTypeConfigDOCUSIGN" }, { "$ref": "#/$defs/SourceTypeConfigINTERCOM" }, { "$ref": "#/$defs/SourceTypeConfigPUBLISH_API" }, { "$ref": "#/$defs/SourceTypeConfigWEBHOOK" }, { "$ref": "#/$defs/SourceTypeConfigHTTP" }, { "$ref": "#/$defs/SourceTypeConfigMANAGED" }, { "$ref": "#/$defs/SourceTypeConfigHOOKDECK_OUTPOST" }, { "$ref": "#/$defs/SourceTypeConfigSANITY" }, { "$ref": "#/$defs/SourceTypeConfigBIGCOMMERCE" }, { "$ref": "#/$defs/SourceTypeConfigCLAUDE" }, { "$ref": "#/$defs/SourceTypeConfigOPENAI" }, { "$ref": "#/$defs/SourceTypeConfigPOLAR" }, { "$ref": "#/$defs/SourceTypeConfigBRIDGE_XYZ" }, { "$ref": "#/$defs/SourceTypeConfigBRIDGE_API" }, { "$ref": "#/$defs/SourceTypeConfigCHARGEBEE_BILLING" }, { "$ref": "#/$defs/SourceTypeConfigCHAINDOTS" }, { "$ref": "#/$defs/SourceTypeConfigCLOUDSIGNAL" }, { "$ref": "#/$defs/SourceTypeConfigCOINBASE" }, { "$ref": "#/$defs/SourceTypeConfigCOURIER" }, { "$ref": "#/$defs/SourceTypeConfigCURSOR" }, { "$ref": "#/$defs/SourceTypeConfigMERAKI" }, { "$ref": "#/$defs/SourceTypeConfigMICROSOFT_GRAPH" }, { "$ref": "#/$defs/SourceTypeConfigMICROSOFT_SHAREPOINT" }, { "$ref": "#/$defs/SourceTypeConfigFIREBLOCKS" }, { "$ref": "#/$defs/SourceTypeConfigFRONTAPP" }, { "$ref": "#/$defs/SourceTypeConfigZOOM" }, { "$ref": "#/$defs/SourceTypeConfigTWITTER" }, { "$ref": "#/$defs/SourceTypeConfigRECHARGE" }, { "$ref": "#/$defs/SourceTypeConfigRECURLY" }, { "$ref": "#/$defs/SourceTypeConfigREVOLUT" }, { "$ref": "#/$defs/SourceTypeConfigRING_CENTRAL" }, { "$ref": "#/$defs/SourceTypeConfigSTRIPE" }, { "$ref": "#/$defs/SourceTypeConfigPROPERTYFINDER" }, { "$ref": "#/$defs/SourceTypeConfigQUOTER" }, { "$ref": "#/$defs/SourceTypeConfigSHOPIFY" }, { "$ref": "#/$defs/SourceTypeConfigTWILIO" }, { "$ref": "#/$defs/SourceTypeConfigGITHUB" }, { "$ref": "#/$defs/SourceTypeConfigPOSTMARK" }, { "$ref": "#/$defs/SourceTypeConfigTALLY" }, { "$ref": "#/$defs/SourceTypeConfigTYPEFORM" }, { "$ref": "#/$defs/SourceTypeConfigPICQER" }, { "$ref": "#/$defs/SourceTypeConfigXERO" }, { "$ref": "#/$defs/SourceTypeConfigSVIX" }, { "$ref": "#/$defs/SourceTypeConfigRESEND" }, { "$ref": "#/$defs/SourceTypeConfigGEMINI" }, { "$ref": "#/$defs/SourceTypeConfigADYEN" }, { "$ref": "#/$defs/SourceTypeConfigAKENEO" }, { "$ref": "#/$defs/SourceTypeConfigGITLAB" }, { "$ref": "#/$defs/SourceTypeConfigWOOCOMMERCE" }, { "$ref": "#/$defs/SourceTypeConfigOKTA" }, { "$ref": "#/$defs/SourceTypeConfigOURA" }, { "$ref": "#/$defs/SourceTypeConfigCOMMERCELAYER" }, { "$ref": "#/$defs/SourceTypeConfigHUBSPOT" }, { "$ref": "#/$defs/SourceTypeConfigMAILGUN" }, { "$ref": "#/$defs/SourceTypeConfigPERSONA" }, { "$ref": "#/$defs/SourceTypeConfigPIPEDRIVE" }, { "$ref": "#/$defs/SourceTypeConfigSENDGRID" }, { "$ref": "#/$defs/SourceTypeConfigWORKOS" }, { "$ref": "#/$defs/SourceTypeConfigSYNCTERA" }, { "$ref": "#/$defs/SourceTypeConfigAWS_SNS" }, { "$ref": "#/$defs/SourceTypeConfigTHREE_D_EYE" }, { "$ref": "#/$defs/SourceTypeConfigTWITCH" }, { "$ref": "#/$defs/SourceTypeConfigENODE" }, { "$ref": "#/$defs/SourceTypeConfigFAUNDIT" }, { "$ref": "#/$defs/SourceTypeConfigFAVRO" }, { "$ref": "#/$defs/SourceTypeConfigLINEAR" }, { "$ref": "#/$defs/SourceTypeConfigSHIPBOB" }, { "$ref": "#/$defs/SourceTypeConfigSHIPHERO" }, { "$ref": "#/$defs/SourceTypeConfigSHOPLINE" }, { "$ref": "#/$defs/SourceTypeConfigWIX" }, { "$ref": "#/$defs/SourceTypeConfigNMI" }, { "$ref": "#/$defs/SourceTypeConfigNEON" }, { "$ref": "#/$defs/SourceTypeConfigORB" }, { "$ref": "#/$defs/SourceTypeConfigPYLON" }, { "$ref": "#/$defs/SourceTypeConfigRAZORPAY" }, { "$ref": "#/$defs/SourceTypeConfigREPAY" }, { "$ref": "#/$defs/SourceTypeConfigSQUARE" }, { "$ref": "#/$defs/SourceTypeConfigSOLIDGATE" }, { "$ref": "#/$defs/SourceTypeConfigTRELLO" }, { "$ref": "#/$defs/SourceTypeConfigEBAY" }, { "$ref": "#/$defs/SourceTypeConfigTELNYX" }, { "$ref": "#/$defs/SourceTypeConfigDISCORD" }, { "$ref": "#/$defs/SourceTypeConfigTOKENIO" }, { "$ref": "#/$defs/SourceTypeConfigFISERV" }, { "$ref": "#/$defs/SourceTypeConfigFUSIONAUTH" }, { "$ref": "#/$defs/SourceTypeConfigBONDSMITH" }, { "$ref": "#/$defs/SourceTypeConfigVERCEL_LOG_DRAINS" }, { "$ref": "#/$defs/SourceTypeConfigVERCEL" }, { "$ref": "#/$defs/SourceTypeConfigTEBEX" }, { "$ref": "#/$defs/SourceTypeConfigSLACK" }, { "$ref": "#/$defs/SourceTypeConfigSMARTCAR" }, { "$ref": "#/$defs/SourceTypeConfigMAILCHIMP" }, { "$ref": "#/$defs/SourceTypeConfigNUVEMSHOP" }, { "$ref": "#/$defs/SourceTypeConfigPADDLE" }, { "$ref": "#/$defs/SourceTypeConfigPAYPAL" }, { "$ref": "#/$defs/SourceTypeConfigPAYMOB" }, { "$ref": "#/$defs/SourceTypeConfigPAYSTACK" }, { "$ref": "#/$defs/SourceTypeConfigSCRAPFLY" }, { "$ref": "#/$defs/SourceTypeConfigPORTAL" }, { "$ref": "#/$defs/SourceTypeConfigTREEZOR" }, { "$ref": "#/$defs/SourceTypeConfigPRAXIS" }, { "$ref": "#/$defs/SourceTypeConfigCUSTOMERIO" }, { "$ref": "#/$defs/SourceTypeConfigEXACT_ONLINE" }, { "$ref": "#/$defs/SourceTypeConfigFACEBOOK" }, { "$ref": "#/$defs/SourceTypeConfigWHATSAPP" }, { "$ref": "#/$defs/SourceTypeConfigREPLICATE" }, { "$ref": "#/$defs/SourceTypeConfigTIKTOK" }, { "$ref": "#/$defs/SourceTypeConfigTIKTOK_SHOP" }, { "$ref": "#/$defs/SourceTypeConfigAIRWALLEX" }, { "$ref": "#/$defs/SourceTypeConfigASCEND" }, { "$ref": "#/$defs/SourceTypeConfigALIPAY" }, { "$ref": "#/$defs/SourceTypeConfigZENDESK" }, { "$ref": "#/$defs/SourceTypeConfigUPOLLO" }, { "$ref": "#/$defs/SourceTypeConfigSMILE" }, { "$ref": "#/$defs/SourceTypeConfigNYLAS" }, { "$ref": "#/$defs/SourceTypeConfigCLIO" }, { "$ref": "#/$defs/SourceTypeConfigGOCARDLESS" }, { "$ref": "#/$defs/SourceTypeConfigLINKEDIN" }, { "$ref": "#/$defs/SourceTypeConfigLITHIC" }, { "$ref": "#/$defs/SourceTypeConfigSTRAVA" }, { "$ref": "#/$defs/SourceTypeConfigUTILA" }, { "$ref": "#/$defs/SourceTypeConfigMONDAY" }, { "$ref": "#/$defs/SourceTypeConfigGREENDOT" }, { "$ref": "#/$defs/SourceTypeConfigZEROHASH" }, { "$ref": "#/$defs/SourceTypeConfigZIFT" }, { "$ref": "#/$defs/SourceTypeConfigETHOCA" }, { "$ref": "#/$defs/SourceTypeConfigAIRTABLE" }, { "$ref": "#/$defs/SourceTypeConfigASANA" }, { "$ref": "#/$defs/SourceTypeConfigASHBY" }, { "$ref": "#/$defs/SourceTypeConfigFASTSPRING" }, { "$ref": "#/$defs/SourceTypeConfigPAYPRO_GLOBAL" }, { "$ref": "#/$defs/SourceTypeConfigUSPS" }, { "$ref": "#/$defs/SourceTypeConfigWALMART" }, { "$ref": "#/$defs/SourceTypeConfigFIREFLIES" }, { "$ref": "#/$defs/SourceTypeConfigFLEXPORT" }, { "$ref": "#/$defs/SourceTypeConfigUBER" }, { "$ref": "#/$defs/SourceTypeConfigWECHAT" }, { "$ref": "#/$defs/SourceTypeConfigCIRCLE" } ], "description": "Configuration object for the source type", "default": {} }, "SourceConfigTwitchAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Twitch" }, "SourceTypeConfigTREEZOR": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigTreezorAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for TREEZOR. Requires type to be `TREEZOR`.", "x-docs-type": "TREEZOR", "x-docs-external-url": "https://docs.treezor.com/guide/webhooks/integrity-checks.html" }, "SourceTypeConfigUSPS": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigUSPSAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for USPS. Requires type to be `USPS`.", "x-docs-type": "USPS", "x-docs-external-url": "https://developers.usps.com/subscriptions-adjustmentsv3#tag/Listener-URL-Specification/operation/post-notification" }, "SourceConfigPipedriveAuth": { "type": "object", "properties": { "username": { "type": "string" }, "password": { "type": "string" } }, "required": [ "username", "password" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Pipedrive" }, "SourceConfigWebhookAuthNeon": { "type": "object", "properties": { "neon_auth_url": { "type": "string" } }, "required": [ "neon_auth_url" ], "additionalProperties": false, "x-docs-type": "NEON" }, "SourceConfigVercelDrainsAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "additionalProperties": false, "nullable": true, "x-docs-type": "Vercel Drains" }, "SourceTypeConfigTOKENIO": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigTokenIOAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for TOKENIO. Requires type to be `TOKENIO`.", "x-docs-type": "TOKENIO", "x-docs-external-url": "https://developer.token.io/token_rest_api_doc/content/e-rest/webhooks.htm?Highlight=webhook#Signature" }, "SourceConfigTelnyxAuth": { "type": "object", "properties": { "public_key": { "type": "string" } }, "required": [ "public_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Telnyx" }, "SourceConfigFireflies.aiAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Fireflies.ai" }, "DestinationConfigHTTPAuthHookdeckSignatureDefault": { "type": "object", "properties": {}, "additionalProperties": false, "x-docs-type": "HOOKDECK_SIGNATURE" }, "RetryStrategy": { "type": "string", "enum": [ "linear", "exponential" ], "description": "Algorithm to use when calculating delay between retries" }, "SourceTypeConfigCLOUDSIGNAL": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigCloudSignalAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for CLOUDSIGNAL. Requires type to be `CLOUDSIGNAL`.", "x-docs-type": "CLOUDSIGNAL" }, "SourceConfigEthocaAuth": { "type": "object", "properties": {}, "additionalProperties": false, "nullable": true, "x-docs-type": "Ethoca" }, "SourceConfigSquareAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Square" }, "SourceTypeConfigTWITTER": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigXAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for TWITTER. Requires type to be `TWITTER`.", "x-docs-type": "TWITTER", "x-docs-external-url": "https://developer.x.com/en/docs/x-api/enterprise/account-activity-api/guides/securing-webhooks" }, "SourceTypeConfigSHIPHERO": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigShipHeroAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for SHIPHERO. Requires type to be `SHIPHERO`.", "x-docs-type": "SHIPHERO", "x-docs-external-url": "https://developer.shiphero.com/webhooks/#webhook_verification" }, "SourceConfigWebhookAuthNMIPaymentGateway": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "NMI" }, "SourceConfigGoogleGeminiAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Google Gemini" }, "SourceConfigWebhookAuthAscend": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "ASCEND" }, "SourceTypeConfigRAZORPAY": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigRazorpayAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for RAZORPAY. Requires type to be `RAZORPAY`.", "x-docs-type": "RAZORPAY", "x-docs-external-url": "https://razorpay.com/docs/webhooks/validate-test/#validate-webhooks" }, "SourceConfigPaypalAuth": { "type": "object", "properties": { "webhook_id": { "type": "string" } }, "required": [ "webhook_id" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Paypal" }, "SourceTypeConfigCUSTOMERIO": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigCustomer.IOAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for CUSTOMERIO. Requires type to be `CUSTOMERIO`.", "x-docs-type": "CUSTOMERIO", "x-docs-external-url": "https://docs.customer.io/journeys/webhooks/#securely-verify-requests" }, "Destination": { "type": "object", "properties": { "id": { "type": "string", "description": "ID of the destination" }, "name": { "type": "string", "description": "A unique, human-friendly name for the destination" }, "description": { "type": "string", "nullable": true, "description": "Description of the destination" }, "team_id": { "type": "string", "description": "ID of the project" }, "type": { "type": "string", "enum": [ "HTTP", "CLI", "MOCK_API" ], "description": "Type of the destination" }, "config": { "$ref": "#/$defs/DestinationConfig" }, "disabled_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Date the destination was disabled" }, "updated_at": { "type": "string", "format": "date-time", "description": "Date the destination was last updated" }, "created_at": { "type": "string", "format": "date-time", "description": "Date the destination was created" } }, "required": [ "id", "name", "team_id", "type", "disabled_at", "updated_at", "created_at" ], "additionalProperties": false, "description": "Associated [Destination](#destination-object) object" }, "SourceConfigWebhookAuthTally": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "TALLY" }, "SourceConfigTallyAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Tally" }, "SourceTypeConfigBONDSMITH": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigBondsmithAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for BONDSMITH. Requires type to be `BONDSMITH`.", "x-docs-type": "BONDSMITH", "x-docs-external-url": "https://docs.bond.tech/docs/signatures" }, "SourceConfigWebhookAuthBasicAuth": { "type": "object", "properties": { "username": { "type": "string" }, "password": { "type": "string" } }, "required": [ "username", "password" ], "additionalProperties": false, "x-docs-type": "BASIC_AUTH" }, "SourceConfigWebhookAuthShopline": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "SHOPLINE" }, "SourceConfigWebhookAuthClaude": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "CLAUDE" }, "SourceTypeConfigFISERV": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigFiservAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for FISERV. Requires type to be `FISERV`.", "x-docs-type": "FISERV" }, "SourceTypeConfigMICROSOFT_GRAPH": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigMicrosoftGraphAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for MICROSOFT_GRAPH. Requires type to be `MICROSOFT_GRAPH`.", "x-docs-type": "MICROSOFT_GRAPH", "x-docs-external-url": "https://learn.microsoft.com/en-us/graph/webhooks" }, "SourceConfigCourierAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Courier" }, "SourceTypeConfigFUSIONAUTH": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigFusionAuthAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for FUSIONAUTH. Requires type to be `FUSIONAUTH`.", "x-docs-type": "FUSIONAUTH", "x-docs-external-url": "https://fusionauth.io/docs/extend/events-and-webhooks/signing" }, "SourceConfigAsanaAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Asana" }, "SourceConfigWebhookAuthFrontApp": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "FRONTAPP" }, "SourceConfigPaystackAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Paystack" }, "SourceTypeConfigSENDGRID": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigSendgridAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for SENDGRID. Requires type to be `SENDGRID`.", "x-docs-type": "SENDGRID" }, "SourceConfigAdyenAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Adyen" }, "SourceConfigFusionAuthAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "FusionAuth" }, "SourceTypeConfigGITHUB": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigGitHubAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for GITHUB. Requires type to be `GITHUB`.", "x-docs-type": "GITHUB", "x-docs-external-url": "https://docs.github.com/en/webhooks/using-webhooks/validating-webhook-deliveries" }, "SourceConfigGitLabAuth": { "type": "object", "properties": { "api_key": { "type": "string" } }, "required": [ "api_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "GitLab" }, "SourceConfigWebhookAuthHubspot": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "HUBSPOT" }, "SourceTypeConfigRECHARGE": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigRechargeAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for RECHARGE. Requires type to be `RECHARGE`.", "x-docs-type": "RECHARGE", "x-docs-external-url": "https://docs.getrecharge.com/docs/webhooks-overview#validating-webhooks" }, "SourceTypeConfigFRONTAPP": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigFrontAppAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for FRONTAPP. Requires type to be `FRONTAPP`.", "x-docs-type": "FRONTAPP", "x-docs-external-url": "https://dev.frontapp.com/docs/webhooks-1#verifying-integrity" }, "SourceConfigWebhookAuthCoinbase": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "COINBASE" }, "SourceTypeConfigCOURIER": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigCourierAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for COURIER. Requires type to be `COURIER`.", "x-docs-type": "COURIER" }, "SourceTypeConfigDOCUSIGN": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigDocuSignAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for DOCUSIGN. Requires type to be `DOCUSIGN`.", "x-docs-type": "DOCUSIGN", "x-docs-external-url": "https://developers.docusign.com/platform/webhooks/connect/validate/" }, "SourceTypeConfigPAYMOB": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigPaymobAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for PAYMOB. Requires type to be `PAYMOB`.", "x-docs-type": "PAYMOB", "x-docs-external-url": "https://developers.paymob.com/paymob-docs/developers/webhook-callbacks-and-hmac/hmac/hmac-transaction-callback" }, "SourceConfigCustomer.IOAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Customer.IO" }, "SourceConfigWebhookAuthTwilio": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "TWILIO" }, "SourceConfigWebhookAuthEmpty": { "nullable": true, "x-docs-hide": true, "x-docs-nullable": true }, "SourceConfigWebhookAuthTikTokShop": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" }, "app_key": { "type": "string" } }, "required": [ "webhook_secret_key", "app_key" ], "additionalProperties": false, "x-docs-type": "TIKTOK_SHOP" }, "SourceTypeConfigREVOLUT": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigRevolutAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for REVOLUT. Requires type to be `REVOLUT`.", "x-docs-type": "REVOLUT", "x-docs-external-url": "https://developer.revolut.com/docs/guides/accept-payments/tutorials/work-with-webhooks/verify-the-payload-signature" }, "SourceConfigWebhookAuthShopify": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "SHOPIFY" }, "SourceConfigWebhookAuthPaypal": { "type": "object", "properties": { "webhook_id": { "type": "string" } }, "required": [ "webhook_id" ], "additionalProperties": false, "x-docs-type": "PAYPAL" }, "SourceConfigWebhookAuthPaystack": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "PAYSTACK" }, "SourceConfigWixAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Wix" }, "SourceConfigNylasAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Nylas" }, "SourceTypeConfigMANAGED": { "type": "object", "properties": { "auth": { "type": "object", "properties": { "token": { "type": "string" } }, "required": [ "token" ], "additionalProperties": false } }, "additionalProperties": false, "x-docs-type": "MANAGED" }, "SourceConfigRecurlyAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Recurly" }, "SourceConfigFlexportAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Flexport" }, "SourceConfigWebhookAuthDiscord": { "type": "object", "properties": { "public_key": { "type": "string" } }, "required": [ "public_key" ], "additionalProperties": false, "x-docs-type": "DISCORD" }, "SourceConfigWebhookAuthWhatsApp": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "WHATSAPP" }, "SourceConfigPostmarkAuth": { "type": "object", "properties": { "username": { "type": "string" }, "password": { "type": "string" } }, "required": [ "username", "password" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Postmark" }, "SourceConfigRevolutAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Revolut" }, "SourceAllowedHTTPMethod": { "type": "array", "items": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] }, "description": "List of allowed HTTP methods. Defaults to PUT, POST, PATCH, DELETE." }, "SourceConfig3dEyeAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "3d Eye" }, "SourceConfigNMIPaymentGatewayAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "NMI Payment Gateway" }, "SourceConfigReplicateAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Replicate" }, "SourceConfigHTTPAuthHMAC": { "type": "object", "properties": { "algorithm": { "type": "string", "enum": [ "sha1", "sha256", "sha512", "md5" ] }, "encoding": { "type": "string", "enum": [ "base64", "base64url", "hex" ] }, "header_key": { "type": "string" }, "webhook_secret_key": { "type": "string" } }, "additionalProperties": false, "x-docs-type": "HMAC" }, "SourceTypeConfigMICROSOFT_SHAREPOINT": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigMicrosoftSharePointAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for MICROSOFT_SHAREPOINT. Requires type to be `MICROSOFT_SHAREPOINT`.", "x-docs-type": "MICROSOFT_SHAREPOINT", "x-docs-external-url": "https://learn.microsoft.com/en-us/sharepoint/dev/apis/webhooks/overview-sharepoint-webhooks" }, "SourceConfigWebhookAuthBridgeAPI": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "BRIDGE_API" }, "SourceConfigBondsmithAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Bondsmith" }, "SourceConfigWebhookAuth": { "type": "object", "properties": {}, "additionalProperties": false, "oneOf": [ { "$ref": "#/$defs/SourceConfigWebhookAuthHMAC" }, { "$ref": "#/$defs/SourceConfigWebhookAuthBasicAuth" }, { "$ref": "#/$defs/SourceConfigWebhookAuthAPIKey" }, { "$ref": "#/$defs/SourceConfigWebhookAuthAiprise" }, { "$ref": "#/$defs/SourceConfigWebhookAuthAlchemy" }, { "$ref": "#/$defs/SourceConfigWebhookAuthDocuSign" }, { "$ref": "#/$defs/SourceConfigWebhookAuthIntercom" }, { "$ref": "#/$defs/SourceConfigWebhookAuthSanity" }, { "$ref": "#/$defs/SourceConfigWebhookAuthBigCommerce" }, { "$ref": "#/$defs/SourceConfigWebhookAuthClaude" }, { "$ref": "#/$defs/SourceConfigWebhookAuthOpenAI" }, { "$ref": "#/$defs/SourceConfigWebhookAuthPolar" }, { "$ref": "#/$defs/SourceConfigWebhookAuthBridgeStablecoins" }, { "$ref": "#/$defs/SourceConfigWebhookAuthBridgeAPI" }, { "$ref": "#/$defs/SourceConfigWebhookAuthChargebeeBilling" }, { "$ref": "#/$defs/SourceConfigWebhookAuthChaindots" }, { "$ref": "#/$defs/SourceConfigWebhookAuthCloudSignal" }, { "$ref": "#/$defs/SourceConfigWebhookAuthCoinbase" }, { "$ref": "#/$defs/SourceConfigWebhookAuthCourier" }, { "$ref": "#/$defs/SourceConfigWebhookAuthCursor" }, { "$ref": "#/$defs/SourceConfigWebhookAuthMeraki" }, { "$ref": "#/$defs/SourceConfigWebhookAuthFireblocks" }, { "$ref": "#/$defs/SourceConfigWebhookAuthFrontApp" }, { "$ref": "#/$defs/SourceConfigWebhookAuthZoom" }, { "$ref": "#/$defs/SourceConfigWebhookAuthX" }, { "$ref": "#/$defs/SourceConfigWebhookAuthRecharge" }, { "$ref": "#/$defs/SourceConfigWebhookAuthRecurly" }, { "$ref": "#/$defs/SourceConfigWebhookAuthRevolut" }, { "$ref": "#/$defs/SourceConfigWebhookAuthRingCentral" }, { "$ref": "#/$defs/SourceConfigWebhookAuthStripe" }, { "$ref": "#/$defs/SourceConfigWebhookAuthPropertyFinder" }, { "$ref": "#/$defs/SourceConfigWebhookAuthQuoter" }, { "$ref": "#/$defs/SourceConfigWebhookAuthShopify" }, { "$ref": "#/$defs/SourceConfigWebhookAuthTwilio" }, { "$ref": "#/$defs/SourceConfigWebhookAuthGitHub" }, { "$ref": "#/$defs/SourceConfigWebhookAuthPostmark" }, { "$ref": "#/$defs/SourceConfigWebhookAuthTally" }, { "$ref": "#/$defs/SourceConfigWebhookAuthTypeform" }, { "$ref": "#/$defs/SourceConfigWebhookAuthPicqer" }, { "$ref": "#/$defs/SourceConfigWebhookAuthXero" }, { "$ref": "#/$defs/SourceConfigWebhookAuthSvix" }, { "$ref": "#/$defs/SourceConfigWebhookAuthResend" }, { "$ref": "#/$defs/SourceConfigWebhookAuthGoogleGemini" }, { "$ref": "#/$defs/SourceConfigWebhookAuthAdyen" }, { "$ref": "#/$defs/SourceConfigWebhookAuthAkeneo" }, { "$ref": "#/$defs/SourceConfigWebhookAuthGitLab" }, { "$ref": "#/$defs/SourceConfigWebhookAuthWooCommerce" }, { "$ref": "#/$defs/SourceConfigWebhookAuthOkta" }, { "$ref": "#/$defs/SourceConfigWebhookAuthOura" }, { "$ref": "#/$defs/SourceConfigWebhookAuthCommerceLayer" }, { "$ref": "#/$defs/SourceConfigWebhookAuthHubspot" }, { "$ref": "#/$defs/SourceConfigWebhookAuthMailgun" }, { "$ref": "#/$defs/SourceConfigWebhookAuthPersona" }, { "$ref": "#/$defs/SourceConfigWebhookAuthPipedrive" }, { "$ref": "#/$defs/SourceConfigWebhookAuthSendgrid" }, { "$ref": "#/$defs/SourceConfigWebhookAuthWorkOS" }, { "$ref": "#/$defs/SourceConfigWebhookAuthSynctera" }, { "$ref": "#/$defs/SourceConfigWebhookAuthAWSSNS" }, { "$ref": "#/$defs/SourceConfigWebhookAuth3dEye" }, { "$ref": "#/$defs/SourceConfigWebhookAuthTwitch" }, { "$ref": "#/$defs/SourceConfigWebhookAuthEnode" }, { "$ref": "#/$defs/SourceConfigWebhookAuthFaundit" }, { "$ref": "#/$defs/SourceConfigWebhookAuthFavro" }, { "$ref": "#/$defs/SourceConfigWebhookAuthLinear" }, { "$ref": "#/$defs/SourceConfigWebhookAuthShipBob" }, { "$ref": "#/$defs/SourceConfigWebhookAuthShipHero" }, { "$ref": "#/$defs/SourceConfigWebhookAuthShopline" }, { "$ref": "#/$defs/SourceConfigWebhookAuthWix" }, { "$ref": "#/$defs/SourceConfigWebhookAuthNMIPaymentGateway" }, { "$ref": "#/$defs/SourceConfigWebhookAuthNeon" }, { "$ref": "#/$defs/SourceConfigWebhookAuthOrb" }, { "$ref": "#/$defs/SourceConfigWebhookAuthPylon" }, { "$ref": "#/$defs/SourceConfigWebhookAuthRazorpay" }, { "$ref": "#/$defs/SourceConfigWebhookAuthRepay" }, { "$ref": "#/$defs/SourceConfigWebhookAuthSquare" }, { "$ref": "#/$defs/SourceConfigWebhookAuthSolidgate" }, { "$ref": "#/$defs/SourceConfigWebhookAuthTrello" }, { "$ref": "#/$defs/SourceConfigWebhookAuthEbay" }, { "$ref": "#/$defs/SourceConfigWebhookAuthTelnyx" }, { "$ref": "#/$defs/SourceConfigWebhookAuthDiscord" }, { "$ref": "#/$defs/SourceConfigWebhookAuthTokenIO" }, { "$ref": "#/$defs/SourceConfigWebhookAuthFiserv" }, { "$ref": "#/$defs/SourceConfigWebhookAuthFusionAuth" }, { "$ref": "#/$defs/SourceConfigWebhookAuthBondsmith" }, { "$ref": "#/$defs/SourceConfigWebhookAuthVercelDrains" }, { "$ref": "#/$defs/SourceConfigWebhookAuthVercelWebhooks" }, { "$ref": "#/$defs/SourceConfigWebhookAuthTebex" }, { "$ref": "#/$defs/SourceConfigWebhookAuthSlack" }, { "$ref": "#/$defs/SourceConfigWebhookAuthSmartcar" }, { "$ref": "#/$defs/SourceConfigWebhookAuthMailchimp" }, { "$ref": "#/$defs/SourceConfigWebhookAuthNuvemshop" }, { "$ref": "#/$defs/SourceConfigWebhookAuthPaddle" }, { "$ref": "#/$defs/SourceConfigWebhookAuthPaypal" }, { "$ref": "#/$defs/SourceConfigWebhookAuthPaymob" }, { "$ref": "#/$defs/SourceConfigWebhookAuthPaystack" }, { "$ref": "#/$defs/SourceConfigWebhookAuthScrapfly" }, { "$ref": "#/$defs/SourceConfigWebhookAuthPortal" }, { "$ref": "#/$defs/SourceConfigWebhookAuthTreezor" }, { "$ref": "#/$defs/SourceConfigWebhookAuthPraxis" }, { "$ref": "#/$defs/SourceConfigWebhookAuthCustomer.IO" }, { "$ref": "#/$defs/SourceConfigWebhookAuthExactOnline" }, { "$ref": "#/$defs/SourceConfigWebhookAuthFacebook" }, { "$ref": "#/$defs/SourceConfigWebhookAuthWhatsApp" }, { "$ref": "#/$defs/SourceConfigWebhookAuthReplicate" }, { "$ref": "#/$defs/SourceConfigWebhookAuthTikTok" }, { "$ref": "#/$defs/SourceConfigWebhookAuthTikTokShop" }, { "$ref": "#/$defs/SourceConfigWebhookAuthAirwallex" }, { "$ref": "#/$defs/SourceConfigWebhookAuthAscend" }, { "$ref": "#/$defs/SourceConfigWebhookAuthAlipay" }, { "$ref": "#/$defs/SourceConfigWebhookAuthZendesk" }, { "$ref": "#/$defs/SourceConfigWebhookAuthUpollo" }, { "$ref": "#/$defs/SourceConfigWebhookAuthSmile" }, { "$ref": "#/$defs/SourceConfigWebhookAuthNylas" }, { "$ref": "#/$defs/SourceConfigWebhookAuthClio" }, { "$ref": "#/$defs/SourceConfigWebhookAuthGoCardless" }, { "$ref": "#/$defs/SourceConfigWebhookAuthLinkedIn" }, { "$ref": "#/$defs/SourceConfigWebhookAuthLithic" }, { "$ref": "#/$defs/SourceConfigWebhookAuthUtila" }, { "$ref": "#/$defs/SourceConfigWebhookAuthGreenDot" }, { "$ref": "#/$defs/SourceConfigWebhookAuthZeroHash" }, { "$ref": "#/$defs/SourceConfigWebhookAuthAirtable" }, { "$ref": "#/$defs/SourceConfigWebhookAuthAsana" }, { "$ref": "#/$defs/SourceConfigWebhookAuthAshby" }, { "$ref": "#/$defs/SourceConfigWebhookAuthFastSpring" }, { "$ref": "#/$defs/SourceConfigWebhookAuthPayProGlobal" }, { "$ref": "#/$defs/SourceConfigWebhookAuthUSPS" }, { "$ref": "#/$defs/SourceConfigWebhookAuthWalmart" }, { "$ref": "#/$defs/SourceConfigWebhookAuthFireflies.ai" }, { "$ref": "#/$defs/SourceConfigWebhookAuthFlexport" }, { "$ref": "#/$defs/SourceConfigWebhookAuthUber" }, { "$ref": "#/$defs/SourceConfigWebhookAuthWeChatPay" }, { "$ref": "#/$defs/SourceConfigWebhookAuthCircle" }, { "$ref": "#/$defs/SourceConfigWebhookAuthEmpty" } ] }, "DestinationConfigHTTPAuthAWSSignature": { "type": "object", "properties": { "access_key_id": { "type": "string" }, "secret_access_key": { "type": "string" }, "region": { "type": "string" }, "service": { "type": "string" } }, "additionalProperties": false, "x-docs-type": "AWS_SIGNATURE" }, "SourceConfigTebexAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Tebex" }, "SourceTypeConfigZOOM": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigZoomAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for ZOOM. Requires type to be `ZOOM`.", "x-docs-type": "ZOOM", "x-docs-external-url": "https://developers.zoom.us/docs/api/webhooks/#verify-webhook-events" }, "SourceTypeConfigCLAUDE": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigClaudeAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for CLAUDE. Requires type to be `CLAUDE`.", "x-docs-type": "CLAUDE", "x-docs-external-url": "https://platform.claude.com/docs/en/managed-agents/webhooks" }, "SourceTypeConfigWECHAT": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigWeChatPayAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for WECHAT. Requires type to be `WECHAT`.", "x-docs-type": "WECHAT", "x-docs-external-url": "https://pay.weixin.qq.com/doc/global/v3/en/4012357149" }, "SourceTypeConfigLINKEDIN": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigLinkedInAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for LINKEDIN. Requires type to be `LINKEDIN`.", "x-docs-type": "LINKEDIN" }, "SourceConfigWebhookAuthZeroHash": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "ZEROHASH" }, "SourceTypeConfigASHBY": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigAshbyAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for ASHBY. Requires type to be `ASHBY`.", "x-docs-type": "ASHBY", "x-docs-external-url": "https://developers.ashbyhq.com/docs/authenticating-webhooks" }, "SourceConfigWebhookAuthWalmart": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "WALMART" }, "SourceConfigRechargeAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Recharge" }, "SourceConfigWebhookAuthLinear": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "LINEAR" }, "SourceConfigAscendAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Ascend" }, "SourceConfigCoinbaseAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Coinbase" }, "SourceTypeConfigSOLIDGATE": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigSolidgateAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for SOLIDGATE. Requires type to be `SOLIDGATE`.", "x-docs-type": "SOLIDGATE", "x-docs-external-url": "https://docs.solidgate.com/payments/integrate/webhooks/#security" }, "SourceTypeConfigTHREE_D_EYE": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfig3dEyeAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for THREE_D_EYE. Requires type to be `THREE_D_EYE`.", "x-docs-type": "THREE_D_EYE" }, "SourceConfigClioAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Clio" }, "SourceConfigWebhookAuthRingCentral": { "type": "object", "properties": { "token": { "type": "string" } }, "required": [ "token" ], "additionalProperties": false, "x-docs-type": "RING_CENTRAL" }, "SourceConfigWebhookAuthOpenAI": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "OPENAI" }, "DestinationConfigCLIAuthEmpty": { "nullable": true, "x-docs-hide": true, "x-docs-nullable": true }, "SourceConfigWebhookAuthRepay": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "REPAY" }, "DestinationConfigCLIAuthHookdeckSignatureDefault": { "type": "object", "properties": {}, "additionalProperties": false, "x-docs-type": "HOOKDECK_SIGNATURE" }, "SourceConfigWebhookAuthOura": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "OURA" }, "SourceConfigWebhookAuthCommerceLayer": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "COMMERCELAYER" }, "SourceConfigTypeformAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Typeform" }, "SourceConfigWebhookAuthBridgeStablecoins": { "type": "object", "properties": { "public_key": { "type": "string" } }, "required": [ "public_key" ], "additionalProperties": false, "x-docs-type": "BRIDGE_XYZ" }, "SourceTypeConfigFACEBOOK": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigFacebookAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for FACEBOOK. Requires type to be `FACEBOOK`.", "x-docs-type": "FACEBOOK" }, "SourceTypeConfigFAVRO": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigFavroAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for FAVRO. Requires type to be `FAVRO`.", "x-docs-type": "FAVRO", "x-docs-external-url": "https://favro.com/developer/#webhook-signatures" }, "SourceConfigWebhookAuthCloudSignal": { "type": "object", "properties": { "api_key": { "type": "string" } }, "required": [ "api_key" ], "additionalProperties": false, "x-docs-type": "CLOUDSIGNAL" }, "DestinationConfigHTTPAuthAPIKey": { "type": "object", "properties": { "key": { "type": "string" }, "api_key": { "type": "string" }, "to": { "type": "string", "enum": [ "header", "query" ] } }, "additionalProperties": false, "x-docs-type": "API_KEY" }, "SourceConfigWhatsAppAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "WhatsApp" }, "SourceTypeConfigFASTSPRING": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigFastSpringAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for FASTSPRING. Requires type to be `FASTSPRING`.", "x-docs-type": "FASTSPRING", "x-docs-external-url": "https://developer.fastspring.com/reference/message-security" }, "SourceConfigSendgridAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Sendgrid" }, "Source": { "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, "description": "Associated [Source](#source-object) object" }, "SourceTypeConfigWOOCOMMERCE": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigWooCommerceAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for WOOCOMMERCE. Requires type to be `WOOCOMMERCE`.", "x-docs-type": "WOOCOMMERCE" }, "SourceTypeConfigDISCORD": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigDiscordAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for DISCORD. Requires type to be `DISCORD`.", "x-docs-type": "DISCORD" }, "SourceTypeConfigMONDAY": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigMondayAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for MONDAY. Requires type to be `MONDAY`.", "x-docs-type": "MONDAY", "x-docs-external-url": "https://support.monday.com/hc/en-us/articles/360003540679-Webhook-integration" }, "SourceConfigWebhookAuthShipBob": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "SHIPBOB" }, "SourceTypeConfigXERO": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigXeroAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for XERO. Requires type to be `XERO`.", "x-docs-type": "XERO", "x-docs-external-url": "https://developer.xero.com/documentation/guides/webhooks/configuring-your-server/" }, "SourceConfigPaddleAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Paddle" }, "SourceTypeConfigEXACT_ONLINE": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigExactOnlineAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for EXACT_ONLINE. Requires type to be `EXACT_ONLINE`.", "x-docs-type": "EXACT_ONLINE", "x-docs-external-url": "https://support.exactonline.com/community/s/knowledge-base#All-All-DNO-Content-webhooksc" }, "SourceTypeConfigSVIX": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigSvixAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for SVIX. Requires type to be `SVIX`.", "x-docs-type": "SVIX" }, "SourceTypeConfigVERCEL_LOG_DRAINS": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigVercelDrainsAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for VERCEL_LOG_DRAINS. Requires type to be `VERCEL_LOG_DRAINS`.", "x-docs-type": "VERCEL_LOG_DRAINS", "x-docs-external-url": "https://vercel.com/docs/rest-api#securing-your-log-drains" }, "SourceTypeConfigCIRCLE": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigCircleAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for CIRCLE. Requires type to be `CIRCLE`.", "x-docs-type": "CIRCLE", "x-docs-external-url": "https://developers.circle.com/cpn/guides/webhooks/verify-webhook-signatures" }, "SourceTypeConfigCHARGEBEE_BILLING": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigChargebeeBillingAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for CHARGEBEE_BILLING. Requires type to be `CHARGEBEE_BILLING`.", "x-docs-type": "CHARGEBEE_BILLING", "x-docs-external-url": "https://www.chargebee.com/docs/billing/2.0/site-configuration/webhook_settings#basic-authentication" }, "SourceConfigHookdeckPublishAPIAuth": { "type": "object", "properties": {}, "additionalProperties": false, "nullable": true, "x-docs-type": "Hookdeck Publish API" }, "SourceTypeConfigWEBHOOK": { "type": "object", "properties": { "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" }, "auth_type": { "type": "string", "enum": [ "HMAC", "BASIC_AUTH", "API_KEY", "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" ], "nullable": true }, "auth": { "$ref": "#/$defs/SourceConfigWebhookAuth" } }, "additionalProperties": false, "description": "The type config for WEBHOOK. Requires type to be `WEBHOOK`.", "x-docs-type": "WEBHOOK" }, "DestinationConfigCLIAuthOAuth2AuthorizationCode": { "type": "object", "properties": { "auth_server": { "type": "string" }, "client_id": { "type": "string" }, "client_secret": { "type": "string" }, "refresh_token": { "type": "string" }, "scope": { "type": "string" } }, "additionalProperties": false, "x-docs-type": "OAUTH2_AUTHORIZATION_CODE" }, "SourceTypeConfigNEON": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigNeonAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for NEON. Requires type to be `NEON`.", "x-docs-type": "NEON", "x-docs-external-url": "https://neon.com/docs/auth/guides/webhooks#signature-verification" }, "SourceConfigWebhookAuthCustomer.IO": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "CUSTOMERIO" }, "SourceConfigWebhookAuthRazorpay": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "RAZORPAY" }, "DestinationConfigMockAPIAuthOAuth2AuthorizationCode": { "type": "object", "properties": { "auth_server": { "type": "string" }, "client_id": { "type": "string" }, "client_secret": { "type": "string" }, "refresh_token": { "type": "string" }, "scope": { "type": "string" } }, "additionalProperties": false, "x-docs-type": "OAUTH2_AUTHORIZATION_CODE" }, "SourceTypeConfigWORKOS": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigWorkOSAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for WORKOS. Requires type to be `WORKOS`.", "x-docs-type": "WORKOS", "x-docs-external-url": "https://workos.com/docs/events/data-syncing/webhooks/3-process-the-events/b-validate-the-requests-manually" }, "SourceConfigAirwallexAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Airwallex" }, "SourceConfigFastSpringAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "FastSpring" }, "SourceConfigTrelloAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Trello" }, "SourceTypeConfigAIRTABLE": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigAirtableAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for AIRTABLE. Requires type to be `AIRTABLE`.", "x-docs-type": "AIRTABLE", "x-docs-external-url": "https://airtable.com/developers/web/api/webhooks-overview#webhook-notification-delivery" }, "SourceTypeConfigZIFT": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigZiftAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for ZIFT. Requires type to be `ZIFT`.", "x-docs-type": "ZIFT", "x-docs-external-url": "https://api.zift.io/#webhooks" }, "SourceConfigWebhookAuthZendesk": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "ZENDESK" }, "SourceTypeConfigPYLON": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigPylonAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for PYLON. Requires type to be `PYLON`.", "x-docs-type": "PYLON", "x-docs-external-url": "https://getpylon.com/developers/guides/using-webhooks/#event-signatures" }, "SourceConfigWebhookAuthSynctera": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "SYNCTERA" }, "SourceConfigMerakiAuth": { "type": "object", "properties": { "api_key": { "type": "string" } }, "required": [ "api_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Meraki" }, "SourceConfigWebhookAuthBondsmith": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "BONDSMITH" }, "DestinationConfigMockAPIAuthAPIKey": { "type": "object", "properties": { "key": { "type": "string" }, "api_key": { "type": "string" }, "to": { "type": "string", "enum": [ "header", "query" ] } }, "additionalProperties": false, "x-docs-type": "API_KEY" }, "SourceConfigHubspotAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Hubspot" }, "SourceConfigPolarAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Polar" }, "DestinationConfig": { "type": "object", "properties": {}, "additionalProperties": false, "oneOf": [ { "$ref": "#/$defs/DestinationTypeConfigHTTP" }, { "$ref": "#/$defs/DestinationTypeConfigCLI" }, { "$ref": "#/$defs/DestinationTypeConfigMOCK_API" } ], "description": "Configuration object for the destination type", "default": {} }, "SourceTypeConfigSLACK": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigSlackAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for SLACK. Requires type to be `SLACK`.", "x-docs-type": "SLACK", "x-docs-external-url": "https://api.slack.com/authentication/verifying-requests-from-slack#validating-a-request" }, "SourceConfigUtilaAuth": { "type": "object", "properties": { "public_key": { "type": "string" } }, "required": [ "public_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Utila" }, "SourceConfigTreezorAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Treezor" }, "SourceTypeConfigSMARTCAR": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigSmartcarAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for SMARTCAR. Requires type to be `SMARTCAR`.", "x-docs-type": "SMARTCAR", "x-docs-external-url": "https://smartcar.com/docs/integrations/webhooks/payload-verification" }, "SourceTypeConfigTWITCH": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigTwitchAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for TWITCH. Requires type to be `TWITCH`.", "x-docs-type": "TWITCH", "x-docs-external-url": "https://dev.twitch.tv/docs/eventsub/handling-webhook-events/#verifying-the-event-message" }, "SourceConfigLinearAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Linear" }, "SourceConfigMailchimpAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Mailchimp" }, "SourceConfigWebhookAuthPayProGlobal": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "PAYPRO_GLOBAL" }, "SourceConfigWebhookAuthWix": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "WIX" }, "SourceConfigWebhookAuthChaindots": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "CHAINDOTS" }, "SourceTypeConfigZENDESK": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigZendeskAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for ZENDESK. Requires type to be `ZENDESK`.", "x-docs-type": "ZENDESK", "x-docs-external-url": "https://developer.zendesk.com/documentation/webhooks/verifying/" }, "SourceConfigWebhookAuthResend": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "RESEND" }, "SourceTypeConfigFIREFLIES": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigFireflies.aiAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for FIREFLIES. Requires type to be `FIREFLIES`.", "x-docs-type": "FIREFLIES", "x-docs-external-url": "https://docs.fireflies.ai/graphql-api/webhooks#webhook-authentication" }, "SourceTypeConfigPOSTMARK": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigPostmarkAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for POSTMARK. Requires type to be `POSTMARK`.", "x-docs-type": "POSTMARK" }, "SourceTypeConfigSANITY": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigSanityAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for SANITY. Requires type to be `SANITY`.", "x-docs-type": "SANITY", "x-docs-external-url": "https://www.sanity.io/docs/webhooks" }, "SourceConfigWebhookAuthFacebook": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "FACEBOOK" }, "DestinationConfigCLIAuthAWSSignature": { "type": "object", "properties": { "access_key_id": { "type": "string" }, "secret_access_key": { "type": "string" }, "region": { "type": "string" }, "service": { "type": "string" } }, "additionalProperties": false, "x-docs-type": "AWS_SIGNATURE" }, "SourceTypeConfigPROPERTYFINDER": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigPropertyFinderAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for PROPERTY-FINDER. Requires type to be `PROPERTY-FINDER`.", "x-docs-type": "PROPERTY-FINDER" }, "SourceConfigWebhookAuthStripe": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "STRIPE" }, "SourceConfigManagedAuth": { "type": "object", "properties": {}, "additionalProperties": false, "nullable": true, "x-docs-type": "Managed" }, "SourceConfigWebhookAuthAPIKey": { "type": "object", "properties": { "header_key": { "type": "string" }, "api_key": { "type": "string" } }, "required": [ "header_key", "api_key" ], "additionalProperties": false, "x-docs-type": "API_KEY" }, "SourceTypeConfigUPOLLO": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigUpolloAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for UPOLLO. Requires type to be `UPOLLO`.", "x-docs-type": "UPOLLO", "x-docs-external-url": "https://app.upollo.ai/docs/reference/webhooks#sign-up-for-upollo" }, "SourceTypeConfigAIPRISE": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigAipriseAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for AIPRISE. Requires type to be `AIPRISE`.", "x-docs-type": "AIPRISE", "x-docs-external-url": "https://docs.aiprise.com/docs/callbacks-authentication" }, "SourceConfigWebhookAuthMailgun": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "MAILGUN" }, "SourceConfigWebhookAuthMailchimp": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "MAILCHIMP" }, "SourceTypeConfigTEBEX": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigTebexAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for TEBEX. Requires type to be `TEBEX`.", "x-docs-type": "TEBEX", "x-docs-external-url": "https://docs.tebex.io/developers/webhooks/overview#verifying-webhook-authenticity" }, "SourceConfigWebhookAuthClio": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "CLIO" }, "SourceTypeConfigRESEND": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigResendAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for RESEND. Requires type to be `RESEND`.", "x-docs-type": "RESEND" }, "SourceConfigTwilioAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Twilio" }, "SourceConfigChaindotsAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Chaindots" }, "SourceConfigWorkOSAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "WorkOS" }, "SourceConfigAWSSNSAuth": { "type": "object", "properties": {}, "additionalProperties": false, "nullable": true, "x-docs-type": "AWS SNS" }, "SourceConfigWebhookAuthGoCardless": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "GOCARDLESS" }, "Rule": { "anyOf": [ { "$ref": "#/$defs/RetryRule" }, { "$ref": "#/$defs/FilterRule" }, { "$ref": "#/$defs/TransformRule" }, { "$ref": "#/$defs/DelayRule" }, { "$ref": "#/$defs/DeduplicateRule" } ] }, "SourceTypeConfigSTRAVA": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigStravaAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for STRAVA. Requires type to be `STRAVA`.", "x-docs-type": "STRAVA" }, "SourceTypeConfigHOOKDECK_OUTPOST": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigManagedAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for HOOKDECK_OUTPOST. Requires type to be `HOOKDECK_OUTPOST`.", "x-docs-type": "HOOKDECK_OUTPOST" }, "SourceTypeConfigPORTAL": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigPortalAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for PORTAL. Requires type to be `PORTAL`.", "x-docs-type": "PORTAL" }, "SourceTypeConfigSYNCTERA": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigSyncteraAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for SYNCTERA. Requires type to be `SYNCTERA`.", "x-docs-type": "SYNCTERA", "x-docs-external-url": "https://dev.synctera.com/docs/webhooks-guide#integration-steps" }, "SourceTypeConfigMERAKI": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigMerakiAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for MERAKI. Requires type to be `MERAKI`.", "x-docs-type": "MERAKI", "x-docs-external-url": "https://developer.cisco.com/meraki/webhooks/introduction/#shared-secret" }, "SourceTypeConfigGOCARDLESS": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigGoCardlessAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for GOCARDLESS. Requires type to be `GOCARDLESS`.", "x-docs-type": "GOCARDLESS", "x-docs-external-url": "https://developer.gocardless.com/getting-started/staying-up-to-date-with-webhooks#staying_up-to-date_with_webhooks" }, "DestinationConfigHTTPAuthBearerToken": { "type": "object", "properties": { "token": { "type": "string" } }, "additionalProperties": false, "x-docs-type": "BEARER_TOKEN" }, "SourceConfigWebhookAuthVercelWebhooks": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "VERCEL" }, "SourceTypeConfigAIRWALLEX": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigAirwallexAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for AIRWALLEX. Requires type to be `AIRWALLEX`.", "x-docs-type": "AIRWALLEX" }, "DestinationConfigMockAPIAuthBasicAuth": { "type": "object", "properties": { "username": { "type": "string" }, "password": { "type": "string" } }, "additionalProperties": false, "x-docs-type": "BASIC_AUTH" }, "SourceTypeConfigREPLICATE": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigReplicateAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for REPLICATE. Requires type to be `REPLICATE`.", "x-docs-type": "REPLICATE", "x-docs-external-url": "https://replicate.com/docs/topics/webhooks/verify-webhook" }, "SourceConfigWebhookAuthPylon": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "PYLON" }, "SourceConfigWebhookAuthOrb": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "ORB" }, "SourceConfigUpolloAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Upollo" }, "SourceConfigWebhookAuthAiprise": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "AIPRISE" }, "SourceTypeConfigHUBSPOT": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigHubspotAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for HUBSPOT. Requires type to be `HUBSPOT`.", "x-docs-type": "HUBSPOT", "x-docs-external-url": "https://developers.hubspot.com/docs/api/webhooks/validating-requests" }, "SourceTypeConfigTIKTOK": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigTikTokAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for TIKTOK. Requires type to be `TIKTOK`.", "x-docs-type": "TIKTOK", "x-docs-external-url": "https://developers.tiktok.com/doc/webhooks-verification" }, "SourceConfigBridgeStablecoinsAuth": { "type": "object", "properties": { "public_key": { "type": "string" } }, "required": [ "public_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Bridge (Stablecoins)" }, "SourceConfigWebhookAuthTebex": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "TEBEX" }, "SourceConfigTikTokAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "TikTok" }, "DestinationTypeConfigHTTP": { "type": "object", "properties": { "url": { "type": "string", "format": "URL" }, "rate_limit": { "type": "number", "format": "float", "nullable": true }, "rate_limit_period": { "type": "string", "enum": [ "second", "minute", "hour", "concurrent" ], "nullable": true }, "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/DestinationConfigHTTPAuth" } }, "required": [ "url" ], "additionalProperties": false, "description": "The type config for HTTP. Requires type to be `HTTP`.", "x-docs-type": "HTTP" }, "SourceConfigWebhookAuthCircle": { "type": "object", "properties": { "api_key": { "type": "string" } }, "required": [ "api_key" ], "additionalProperties": false, "x-docs-type": "CIRCLE" }, "SourceConfigWebhookAuthLinkedIn": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "LINKEDIN" }, "SourceTypeConfigSCRAPFLY": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigScrapflyAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for SCRAPFLY. Requires type to be `SCRAPFLY`.", "x-docs-type": "SCRAPFLY", "x-docs-external-url": "https://scrapfly.io/docs/scrape-api/webhook" }, "SourceTypeConfigNUVEMSHOP": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigNuvemshopAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for NUVEMSHOP. Requires type to be `NUVEMSHOP`.", "x-docs-type": "NUVEMSHOP", "x-docs-external-url": "https://tiendanube.github.io/api-documentation/resources/webhook" }, "SourceConfigWebhookAuthFusionAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "FUSIONAUTH" }, "SourceConfigWebhookAuthSlack": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "SLACK" }, "SourceConfigSmartcarAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Smartcar" }, "SourceConfigWebhookAuthTokenIO": { "type": "object", "properties": { "public_key": { "type": "string" } }, "required": [ "public_key" ], "additionalProperties": false, "x-docs-type": "TOKENIO" }, "SourceConfigAirtableAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Airtable" }, "SourceConfigWebhookAuthAdyen": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "ADYEN" }, "SourceTypeConfigQUOTER": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigQuoterAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for QUOTER. Requires type to be `QUOTER`.", "x-docs-type": "QUOTER", "x-docs-external-url": "https://help.quoter.com/hc/en-us/articles/32085971955355-Integrate-with-Webhooks#h_73bb393dfd" }, "SourceConfigWebhookAuthNuvemshop": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "NUVEMSHOP" }, "SourceConfigWebhookAuthAshby": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "ASHBY" }, "SourceConfigAlipayAuth": { "type": "object", "properties": { "public_key": { "type": "string" } }, "required": [ "public_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Alipay" }, "SourceConfigWebhookAuthFavro": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "FAVRO" }, "SourceConfigWebhookAuthGreenDot": { "type": "object", "properties": { "username": { "type": "string" }, "password": { "type": "string" } }, "required": [ "username", "password" ], "additionalProperties": false, "x-docs-type": "GREENDOT" }, "SourceConfigWebhookAuthPraxis": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "PRAXIS" }, "DestinationConfigMockAPIAuthAWSSignature": { "type": "object", "properties": { "access_key_id": { "type": "string" }, "secret_access_key": { "type": "string" }, "region": { "type": "string" }, "service": { "type": "string" } }, "additionalProperties": false, "x-docs-type": "AWS_SIGNATURE" }, "DestinationConfigCLIAuthOAuth2ClientCredentials": { "type": "object", "properties": { "auth_server": { "type": "string" }, "client_id": { "type": "string" }, "client_secret": { "type": "string" }, "scope": { "type": "string" }, "authentication_type": { "type": "string", "enum": [ "basic", "bearer", "x-www-form-urlencoded" ] } }, "additionalProperties": false, "x-docs-type": "OAUTH2_CLIENT_CREDENTIALS" }, "SourceConfigNuvemshopAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Nuvemshop" }, "SourceConfigHTTPAuthEmpty": { "nullable": true, "x-docs-hide": true, "x-docs-nullable": true }, "SourceConfigZoomAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Zoom" }, "SourceTypeConfigLINEAR": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigLinearAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for LINEAR. Requires type to be `LINEAR`.", "x-docs-type": "LINEAR", "x-docs-external-url": "https://developers.linear.app/docs/graphql/webhooks#securing-webhooks" }, "SourceConfigWebhookAuthTypeform": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "TYPEFORM" }, "SourceConfigWebhookAuthTwitch": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "TWITCH" }, "SourceConfigCommerceLayerAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Commerce Layer" }, "SourceConfigWebhookAuthAWSSNS": { "type": "object", "properties": {}, "additionalProperties": false, "x-docs-type": "AWS_SNS" }, "SourceConfigXAuth": { "type": "object", "properties": { "api_key": { "type": "string" } }, "required": [ "api_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "X" }, "SourceTypeConfigPAYPAL": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigPaypalAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for PAYPAL. Requires type to be `PAYPAL`.", "x-docs-type": "PAYPAL", "x-docs-external-url": "https://developer.paypal.com/api/rest/webhooks/rest/" }, "SourceConfigPersonaAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Persona" }, "SourceConfigUSPSAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "USPS" }, "SourceTypeConfigBRIDGE_XYZ": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigBridgeStablecoinsAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for BRIDGE_XYZ. Requires type to be `BRIDGE_XYZ`.", "x-docs-type": "BRIDGE_XYZ", "x-docs-external-url": "https://apidocs.bridge.xyz/docs/webhook-event-signature-verification" }, "SourceTypeConfigPERSONA": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigPersonaAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for PERSONA. Requires type to be `PERSONA`.", "x-docs-type": "PERSONA", "x-docs-external-url": "https://docs.withpersona.com/docs/webhooks-best-practices#checking-signatures" }, "SourceTypeConfigUTILA": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigUtilaAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for UTILA. Requires type to be `UTILA`.", "x-docs-type": "UTILA", "x-docs-external-url": "https://docs.utila.io/reference/webhooks" }, "SourceConfigWeChatPayAuth": { "type": "object", "properties": { "public_key": { "type": "string" } }, "required": [ "public_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "WeChat Pay" }, "SourceConfigWebhookAuthScrapfly": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "SCRAPFLY" }, "SourceConfigWebhookAuthAlipay": { "type": "object", "properties": { "public_key": { "type": "string" } }, "required": [ "public_key" ], "additionalProperties": false, "x-docs-type": "ALIPAY" }, "SourceConfigWebhookAuthTreezor": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "TREEZOR" }, "SourceTypeConfigPOLAR": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigPolarAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for POLAR. Requires type to be `POLAR`.", "x-docs-type": "POLAR" }, "SourceConfigWebhookAuthOkta": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "x-docs-type": "OKTA" }, "SourceTypeConfigTWILIO": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigTwilioAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for TWILIO. Requires type to be `TWILIO`.", "x-docs-type": "TWILIO", "x-docs-external-url": "https://www.twilio.com/docs/usage/webhooks/webhooks-security#validating-signatures-from-twilio" }, "SourceTypeConfigAKENEO": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigAkeneoAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for AKENEO. Requires type to be `AKENEO`.", "x-docs-type": "AKENEO" }, "SourceConfigBridgeAPIAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Bridge API" }, "SourceTypeConfigCURSOR": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigCursorAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for CURSOR. Requires type to be `CURSOR`.", "x-docs-type": "CURSOR", "x-docs-external-url": "https://cursor.com/docs/cloud-agent/api/webhooks" }, "SourceConfigSvixAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Svix" }, "SourceConfigClaudeAuth": { "type": "object", "properties": { "webhook_secret_key": { "type": "string" } }, "required": [ "webhook_secret_key" ], "additionalProperties": false, "nullable": true, "x-docs-type": "Claude" }, "SourceTypeConfigPADDLE": { "type": "object", "properties": { "auth": { "$ref": "#/$defs/SourceConfigPaddleAuth" }, "allowed_http_methods": { "$ref": "#/$defs/SourceAllowedHTTPMethod" }, "custom_response": { "$ref": "#/$defs/SourceCustomResponse" } }, "additionalProperties": false, "description": "The type config for PADDLE. Requires type to be `PADDLE`.", "x-docs-type": "PADDLE", "x-docs-external-url": "https://developer.paddle.com/webhooks/signature-verification" }, "DestinationConfigHTTPAuthOAuth2AuthorizationCode": { "type": "object", "properties": { "auth_server": { "type": "string" }, "client_id": { "type": "string" }, "client_secret": { "type": "string" }, "refresh_token": { "type": "string" }, "scope": { "type": "string" } }, "additionalProperties": false, "x-docs-type": "OAUTH2_AUTHORIZATION_CODE" } } }