Built and signed on GitHub ActionsBuilt and signed on GitHub Actions
The Hookdeck TypeScript SDK provides programmatic control of the Hookdeck platform via the Hookdeck API. Hookdeck is a platform to receive, send, queue, transform, filter, and throttle events (e.g. webhooks) within your event-driven applications.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
Error code of the delivery attempt
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
Query object to filter records
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
Period to rate limit attempts
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
Period to rate limit attempts
This file was auto-generated by Fern from our API Definition.
Period to rate limit attempts
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
Period to rate limit attempts
This file was auto-generated by Fern from our API Definition.
Keys used as the aggregation keys a 'delivery' type issue
Reference to the event and attempt an issue is being created for.
Period to rate limit attempts
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
Period to rate limit attempts
Period to rate limit attempts
API key config for the destination's auth method
Whether the API key should be sent as a header or a query parameter
AWS Signature config for the destination's auth method
Basic auth config for the destination's auth method
Bearer token config for the destination's auth method
Custom signature config for the destination's auth method
OAuth2 Client Credentials config for the destination's auth method
Basic (default) or Bearer Authentication
Empty config for the destination's auth method
Period to rate limit attempts
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
Period to rate limit attempts
Period to rate limit attempts
This file was auto-generated by Fern from our API Definition.
Response body from the destination
Filter properties for the events to be included in the bulk retry
Filter by number of attempts
URL Encoded string of the JSON to match to the data body
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
Filter by CLI IDs. ?[any]=true operator for any CLI.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
Filter by created_at date using a date operator
Filter by destination IDs
Filter by error code code
This file was auto-generated by Fern from our API Definition.
URL Encoded string of the JSON to match to the data headers
This file was auto-generated by Fern from our API Definition.
Filter by event IDs
This file was auto-generated by Fern from our API Definition.
Filter by last_attempt_at date using a date operator
URL Encoded string of the JSON to match to the parsed query (JSON representation of the query)
This file was auto-generated by Fern from our API Definition.
Filter by HTTP response status code
Filter by source IDs
Lifecyle status of the event
Filter by successful_at date using a date operator
Filter by webhook connection IDs
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
Filter properties for the events to be included in the bulk retry
Filter by number of attempts
URL Encoded string of the JSON to match to the data body
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
Filter by CLI IDs. ?[any]=true operator for any CLI.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
Filter by created_at date using a date operator
Filter by destination IDs
Filter by error code code
This file was auto-generated by Fern from our API Definition.
URL Encoded string of the JSON to match to the data headers
This file was auto-generated by Fern from our API Definition.
Filter by event IDs
This file was auto-generated by Fern from our API Definition.
Filter by last_attempt_at date using a date operator
URL Encoded string of the JSON to match to the parsed query (JSON representation of the query)
This file was auto-generated by Fern from our API Definition.
Filter by HTTP response status code
Filter by source IDs
Lifecyle status of the event
Filter by successful_at date using a date operator
Filter by webhook connection IDs
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
JSON using our filter syntax to filter on request headers
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
Filter by the bulk retry ignored event query object
The cause of the ignored event
Connection ID of the ignored event
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
Filter by the bulk retry ignored event query object
The cause of the ignored event
Connection ID of the ignored event
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
Decrypted Key/Value object of the associated configuration for that provider
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
- Adyen
- Akeneo
- ApiKey
- AwsSns
- BasicAuth
- Bondsmith
- Cloudsignal
- Commercelayer
- Courier
- Discord
- Ebay
- Enode
- Favro
- Fiserv
- Frontapp
- Github
- Gitlab
- Hmac
- Hubspot
- Linear
- Mailchimp
- Mailgun
- Nmi
- Orb
- Oura
- Paddle
- Persona
- Pipedrive
- Postmark
- PropertyFinder
- Pylon
- Razorpay
- Recharge
- Repay
- Sanity
- Sendgrid
- Shopify
- Shopline
- Slack
- Solidgate
- Square
- Stripe
- Svix
- Synctera
- Tebex
- Telnyx
- ThreeDEye
- Tokenio
- Trello
- Twilio
- Twitch
- Typeform
- Vercel
- VercelLogDrains
- Wix
- Woocommerce
- Workos
- Xero
- Zoom
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
Configuration object for the specific issue type selected
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
Configuration object for the specific issue type selected
Configuration object for the specific issue type selected
Configurations for a 'Backpressure' issue trigger
A pattern to match on the destination name or array of destination IDs. Use * as wildcard.
The minimum delay (backpressure) to open the issue for min of 1 minute (60000) and max of 1 day (86400000)
Notification channels object for the specific channel type
Configuration object for the specific issue type selected
Configurations for a 'delivery' issue trigger
A pattern to match on the connection name or array of connection IDs. Use * as wildcard.
Email channel for an issue trigger
Integration channel for an issue trigger
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
Configuration object for the specific issue type selected
Configurations for a 'Transformation' issue trigger
A pattern to match on the transformation name or array of transformation IDs. Use * as wildcard.
Configuration object for the specific issue type selected
Configuration object for the specific issue type selected
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
Filter properties for the events to be included in the bulk retry, use query parameters of Requests
URL Encoded string of the JSON to match to the data body
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
Filter by count of events
URL Encoded string of the JSON to match to the data headers
This file was auto-generated by Fern from our API Definition.
Filter by requests IDs
Filter by count of ignored events
Filter by event ingested date
URL Encoded string of the JSON to match to the parsed query (JSON representation of the query)
This file was auto-generated by Fern from our API Definition.
Filter by rejection cause
Filter by source IDs
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
Filter properties for the events to be included in the bulk retry, use query parameters of Requests
URL Encoded string of the JSON to match to the data body
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
Filter by count of events
URL Encoded string of the JSON to match to the data headers
This file was auto-generated by Fern from our API Definition.
Filter by requests IDs
Filter by count of ignored events
Filter by event ingested date
URL Encoded string of the JSON to match to the parsed query (JSON representation of the query)
This file was auto-generated by Fern from our API Definition.
Filter by rejection cause
Filter by source IDs
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
JSON or string representation of the body
This file was auto-generated by Fern from our API Definition.
JSON representation of the headers
JSON representation of query params
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
List of allowed HTTP methods. Defaults to PUT, POST, PATCH, DELETE.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
Request input to use for the transformation execution
Body of the request
This file was auto-generated by Fern from our API Definition.
JSON representation of the query params
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
Keys used as the aggregation keys a 'transformation' type issue
Reference to the event request transformation an issue is being created for.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
This file was auto-generated by Fern from our API Definition.
Request input to use for the transformation execution
Body of the request
This file was auto-generated by Fern from our API Definition.
JSON representation of the query params
You can optionally define a new transformation while creating a transform rule
This file was auto-generated by Fern from our API Definition.
The verification configs for 3dEye. Only included if the ?include=verification.configs query param is present
The verification configs for Adyen. Only included if the ?include=verification.configs query param is present
The verification configs for Akeneo. Only included if the ?include=verification.configs query param is present
The verification configs for API Key. Only included if the ?include=verification.configs query param is present
The verification configs for AWS SNS. Only included if the ?include=verification.configs query param is present
The verification configs for Basic Auth. Only included if the ?include=verification.configs query param is present
The verification configs for Bondsmith. Only included if the ?include=verification.configs query param is present
The verification configs for Cloud Signal. Only included if the ?include=verification.configs query param is present
The verification configs for Commercelayer. Only included if the ?include=verification.configs query param is present
The verification configs for Courier. Only included if the ?include=verification.configs query param is present
The verification configs for Discord. Only included if the ?include=verification.configs query param is present
The verification configs for Ebay. Only included if the ?include=verification.configs query param is present
The verification configs for Enode. Only included if the ?include=verification.configs query param is present
The verification configs for Favro. Only included if the ?include=verification.configs query param is present
The verification configs for Fiserv. Only included if the ?include=verification.configs query param is present
The verification configs for FrontApp. Only included if the ?include=verification.configs query param is present
The verification configs for GitHub. Only included if the ?include=verification.configs query param is present
The verification configs for GitLab. Only included if the ?include=verification.configs query param is present
The verification configs for HMAC. Only included if the ?include=verification.configs query param is present
This file was auto-generated by Fern from our API Definition.
The verification configs for Hubspot. Only included if the ?include=verification.configs query param is present
The verification configs for Linear. Only included if the ?include=verification.configs query param is present
The verification configs for Mailchimp. Only included if the ?include=verification.configs query param is present
The verification configs for Mailgun. Only included if the ?include=verification.configs query param is present
The verification configs for NMI Payment Gateway. Only included if the ?include=verification.configs query param is present
The verification configs for Orb. Only included if the ?include=verification.configs query param is present
The verification configs for Oura. Only included if the ?include=verification.configs query param is present
The verification configs for Paddle. Only included if the ?include=verification.configs query param is present
The verification configs for Persona. Only included if the ?include=verification.configs query param is present
The verification configs for Pipedrive. Only included if the ?include=verification.configs query param is present
The verification configs for Postmark. Only included if the ?include=verification.configs query param is present
The verification configs for Property Finder. Only included if the ?include=verification.configs query param is present
The verification configs for Pylon. Only included if the ?include=verification.configs query param is present
The verification configs for Razorpay. Only included if the ?include=verification.configs query param is present
The verification configs for Recharge. Only included if the ?include=verification.configs query param is present
This file was auto-generated by Fern from our API Definition.
The verification configs for Repay. Only included if the ?include=verification.configs query param is present
The verification configs for Sanity. Only included if the ?include=verification.configs query param is present
The verification configs for SendGrid. Only included if the ?include=verification.configs query param is present
The verification configs for Shopify. Only included if the ?include=verification.configs query param is present
This file was auto-generated by Fern from our API Definition.
The verification configs for Shopline. Only included if the ?include=verification.configs query param is present
The verification configs for Slack. Only included if the ?include=verification.configs query param is present
The verification configs for SolidGate. Only included if the ?include=verification.configs query param is present
The verification configs for Square. Only included if the ?include=verification.configs query param is present
The verification configs for Stripe. Only included if the ?include=verification.configs query param is present
The verification configs for Svix. Only included if the ?include=verification.configs query param is present
The verification configs for Synctera. Only included if the ?include=verification.configs query param is present
The verification configs for Tebex. Only included if the ?include=verification.configs query param is present
The verification configs for Telnyx. Only included if the ?include=verification.configs query param is present
The verification configs for TokenIO. Only included if the ?include=verification.configs query param is present
The verification configs for Trello. Only included if the ?include=verification.configs query param is present
The verification configs for Twilio. Only included if the ?include=verification.configs query param is present
The verification configs for Twitch. Only included if the ?include=verification.configs query param is present
The verification configs for Twitter. Only included if the ?include=verification.configs query param is present
The verification configs for Typeform. Only included if the ?include=verification.configs query param is present
The verification configs for Vercel. Only included if the ?include=verification.configs query param is present
The verification configs for Vercel Log Drains. Only included if the ?include=verification.configs query param is present
The verification configs for Wix. Only included if the ?include=verification.configs query param is present
The verification configs for WooCommerce. Only included if the ?include=verification.configs query param is present
The verification configs for WorkOS. Only included if the ?include=verification.configs query param is present
The verification configs for Xero. Only included if the ?include=verification.configs query param is present
The verification configs for Zoom. Only included if the ?include=verification.configs query param is present
- _attempt
- _bookmark
- _connection
- _customDomain
- _destination
- _event
- _eventBulkRetry
- _ignoredEventBulkRetry
- _issue
- _issueTrigger
- _notification
- _request
- _requestBulkRetry
- _source
- _transformation
- attempt
- bookmark
- connection
- customDomain
- destination
- event
- eventBulkRetry
- ignoredEventBulkRetry
- issue
- issueTrigger
- notification
- request
- requestBulkRetry
- source
- transformation
This file was auto-generated by Fern from our API Definition.