HOhookdeck
Sources

Disable a source

Changed on

This endpoint disables a source. A disabled source will no longer receive any events, and all connections associated with this source will also be disabled.

put/sources/{id}/archive

Request

  • Base URL
    https://api.hookdeck.com/2025-07-01
  • Auth
    • HTTP bearer
    • or HTTP basic

Path parameters

idstring required

Source ID

Response

A single source

idstring required

ID of the source

namestring required

Name for the source

descriptionstring nullable

Description of the source

team_idstring required

ID of the project

urlstring URL required

A unique URL that must be supplied to your webhook's provider

type'AIPRISE' | 'AIRCALL' | 'ALCHEMY' | 'ATTENTIVE' | 'DOCUSIGN' | 'INTERCOM' | 'PUBLISH_API' | 'WEBHOOK' | 'HTTP' | 'MANAGED' | 'HOOKDECK_OUTPOST' | 'SANITY' | 'BASELINKER' | 'BIGCOMMERCE' | 'CLAUDE' | 'OPENAI' | 'POLAR' | 'BRIDGE_XYZ' | 'BRIDGE_API' | 'CHARGEBEE_BILLING' | 'CHAINDOTS' | 'CLOUDSIGNAL' | 'COINBASE' | 'COURIER' | 'CURSOR' | 'MERAKI' | 'MICROSOFT_GRAPH' | 'MICROSOFT_SHAREPOINT' | 'AZURE_EVENT_GRID' | 'FIREBLOCKS' | 'FRONTAPP' | 'ZOOM' | 'TWITTER' | 'RECHARGE' | 'CRONOFY' | 'RECURLY' | 'RETELL' | 'REVOLUT' | 'RING_CENTRAL' | 'STRIPE' | 'CLOUDINARY' | 'PROPERTY-FINDER' | 'QUO' | 'QUOTER' | 'SHOPIFY' | 'TWILIO' | 'GITHUB' | 'POSTMARK' | 'TALLY' | 'TYPEFORM' | 'PICQER' | 'XERO' | 'SVIX' | 'RESEND' | 'GEMINI' | 'ADYEN' | 'AKENEO' | 'GITLAB' | 'WOOCOMMERCE' | 'OKTA' | 'OURA' | 'COMMERCELAYER' | 'COMMUNITY' | 'HUBSPOT' | 'MAILERSEND' | 'MAILGUN' | 'PERSONA' | 'PIPEDRIVE' | 'SENDGRID' | 'SENDGRID_INBOUND' | 'WORKOS' | 'SYNCTERA' | 'AWS_SNS' | 'THREE_D_EYE' | 'TWITCH' | 'ELEVENLABS' | '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' | 'TIKKIE' | 'TIKTOK' | 'TIKTOK_SHOP' | 'AIRWALLEX' | 'ASCEND' | 'ALIPAY' | 'ZENDESK' | 'UPOLLO' | 'SMILE' | 'NYLAS' | 'CLIO' | 'GOCARDLESS' | 'GOOGLE_PUBSUB' | 'LINKEDIN' | 'LITHIC' | 'STRAVA' | 'UTILA' | 'MONDAY' | 'GREENDOT' | 'ZEROHASH' | 'ZIFT' | 'ETHOCA' | 'AIRTABLE' | 'ASANA' | 'ASHBY' | 'FASTSPRING' | 'PAYPRO_GLOBAL' | 'USPS' | 'WALMART' | 'FIREFLIES' | 'FLEXPORT' | 'UBER' | 'WECHAT' | 'BUNNY_STREAM' | 'SHIPSTATION' | 'CIRCLE' | 'STATSIG' | 'VAPI' | 'VOLUME' | 'FORMSTACK' required

Type of the source

authenticatedboolean required

Whether the source is authenticated

disabled_atstring date-time nullable required

Date the source was disabled

updated_atstring date-time required

Date the source was last updated

created_atstring date-time required

Date the source was created

Changes

  • 9bebff6c68f9Revision changes
    • breaking

      added subschema #4 to the ///// response property oneOf list for the response status

    • breaking

      added to the response property oneOf list for the response status

    • breaking

      removed the required property ////// from the response with the status

    • warning

      added the new SENDGRID_INBOUND enum value to the ///// response property for the response status

    • warning

      added the new SENDGRID_INBOUND enum value to the response property for the response status

    • info

      added the optional property ///// to the response with the status

    • info

      removed from the ///// response property oneOf list for the response status

  • 8e3ce7869510Revision changes
    • breaking

      added to the ///// response property oneOf list for the response status

    • breaking

      added to the response property oneOf list for the response status

    • warning

      added the new QUO enum value to the ///// response property for the response status

    • warning

      added the new QUO enum value to the response property for the response status