Manage sources — the upstream endpoints (webhook senders or push channels) that ingest events into Hookdeck. Sources support platform-specific verification (Stripe, GitHub, Twilio, Shopify, and many more), allowed HTTP methods, allowed content types, allowed IPs, and a configurable custom response returned to the caller.
openapi: 3.0.1
info:
title: Hookdeck Sources API
version: 1.0.0
description: Manage sources — the upstream endpoints (webhook senders or push channels) that ingest events into Hookdeck.
Supports source-type configuration, verification, allowed HTTP methods, and custom response.
contact:
name: Hookdeck Support
url: https://hookdeck.com/contact-us
email: info@hookdeck.com
servers:
- url: https://api.hookdeck.com/2025-07-01
description: Production API
security:
- bearerAuth: []
- basicAuth: []
tags:
- name: Sources
description: A source represents any third party that sends webhooks to Hookdeck.
paths:
/sources:
get:
operationId: getSources
summary: Retrieve sources
description: This endpoint lists sources, or a subset of sources.
tags:
- Sources
responses:
'200':
description: List of sources
content:
application/json:
schema:
$ref: '#/components/schemas/SourcePaginatedResult'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
'422':
description: Unprocessable Entity
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
parameters:
- in: query
name: id
schema:
anyOf:
- type: string
maxLength: 255
- type: array
items:
type: string
maxLength: 255
description: Filter by source IDs
- in: query
name: name
schema:
anyOf:
- type: string
pattern: ^[A-z0-9-_]+$
maxLength: 155
- $ref: '#/components/schemas/Operators'
- type: array
items:
type: string
pattern: ^[A-z0-9-_]+$
maxLength: 155
description: The source name
- in: query
name: type
schema:
anyOf:
- 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
- type: array
items:
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: Filter by source type
- in: query
name: disabled
schema:
type: boolean
description: Include disabled resources in the response
- in: query
name: disabled_at
schema:
anyOf:
- type: string
format: date-time
nullable: true
- $ref: '#/components/schemas/Operators'
description: Date the source was disabled
- in: query
name: order_by
schema:
type: string
maxLength: 255
enum:
- name
- created_at
- updated_at
description: Sort key
- in: query
name: dir
schema:
type: string
enum:
- asc
- desc
description: Sort direction
- in: query
name: limit
schema:
type: integer
minimum: 0
maximum: 255
description: Result set size
- in: query
name: next
schema:
type: string
maxLength: 255
description: The ID to provide in the query to get the next set of results
- in: query
name: prev
schema:
type: string
maxLength: 255
description: The ID to provide in the query to get the previous set of results
post:
operationId: createSource
summary: Create a source
description: This endpoint creates a source.
tags:
- Sources
responses:
'200':
description: A single source
content:
application/json:
schema:
$ref: '#/components/schemas/Source'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
'422':
description: Unprocessable Entity
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
pattern: ^[A-z0-9-_]+$
maxLength: 155
description: A unique name for the source
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
default: WEBHOOK
description:
type: string
maxLength: 500
nullable: true
description: Description for the source
config:
$ref: '#/components/schemas/SourceTypeConfig'
required:
- name
additionalProperties: false
put:
operationId: upsertSource
summary: Create/Update a source
description: This endpoint creates a source, or updates an existing source by name.
tags:
- Sources
responses:
'200':
description: A single source
content:
application/json:
schema:
$ref: '#/components/schemas/Source'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
'422':
description: Unprocessable Entity
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
pattern: ^[A-z0-9-_]+$
maxLength: 155
description: A unique name for the source
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
default: WEBHOOK
description:
type: string
maxLength: 500
nullable: true
description: Description for the source
config:
$ref: '#/components/schemas/SourceTypeConfig'
required:
- name
additionalProperties: false
/sources/count:
get:
operationId: countSources
summary: Count sources
description: ''
tags:
- Sources
responses:
'200':
description: Count of sources
content:
application/json:
schema:
type: object
properties:
count:
type: number
format: float
description: Count of sources
required:
- count
additionalProperties: false
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
'422':
description: Unprocessable Entity
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
parameters: []
/sources/{id}:
get:
operationId: getSource
summary: Retrieve a source
description: This endpoint retrieves a specific source.
tags:
- Sources
responses:
'200':
description: A single source
content:
application/json:
schema:
$ref: '#/components/schemas/Source'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
'410':
description: Gone
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
parameters:
- in: query
name: include
schema:
type: string
enum:
- config.auth
- in: path
name: id
schema:
type: string
description: Source ID
required: true
put:
operationId: updateSource
summary: Update a source
description: This endpoint updates a source.
tags:
- Sources
responses:
'200':
description: A single source
content:
application/json:
schema:
$ref: '#/components/schemas/Source'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
'422':
description: Unprocessable Entity
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
parameters:
- in: path
name: id
schema:
type: string
description: Source ID
required: true
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
pattern: ^[A-z0-9-_]+$
maxLength: 155
description: A unique name for the source
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
description:
type: string
maxLength: 500
nullable: true
description: Description for the source
config:
$ref: '#/components/schemas/SourceTypeConfig'
additionalProperties: false
delete:
operationId: deleteSource
summary: Delete a source
description: This endpoint permanently deletes a source. This action cannot be undone.
tags:
- Sources
responses:
'200':
description: A single source
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: ID of the source
required:
- id
additionalProperties: false
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
parameters:
- in: path
name: id
schema:
type: string
required: true
/sources/{id}/disable:
put:
operationId: disableSource
summary: Disable a source
description: 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.
tags:
- Sources
responses:
'200':
description: A single source
content:
application/json:
schema:
$ref: '#/components/schemas/Source'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
parameters:
- in: path
name: id
schema:
type: string
description: Source ID
required: true
/sources/{id}/archive:
put:
operationId: disableSource_archive
summary: Disable a source
description: 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.
tags:
- Sources
responses:
'200':
description: A single source
content:
application/json:
schema:
$ref: '#/components/schemas/Source'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
parameters:
- in: path
name: id
schema:
type: string
description: Source ID
required: true
/sources/{id}/enable:
put:
operationId: enableSource
summary: Enable a source
description: This endpoint enables a source that was previously disabled.
tags:
- Sources
responses:
'200':
description: A single source
content:
application/json:
schema:
$ref: '#/components/schemas/Source'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
parameters:
- in: path
name: id
schema:
type: string
description: Source ID
required: true
/sources/{id}/unarchive:
put:
operationId: enableSource_unarchive
summary: Enable a source
description: This endpoint enables a source that was previously disabled.
tags:
- Sources
responses:
'200':
description: A single source
content:
# --- truncated at 32 KB (206 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/hookdeck/refs/heads/main/openapi/hookdeck-sources-api-openapi.yml