Hookdeck

Learn how to use Hookdeck with Composio

Overview

SLUG: HOOKDECK

Description

Hookdeck is a platform that enables developers to manage, monitor, and secure webhooks and API events.

Authentication Details

generic_api_key
stringRequired

Connecting to Hookdeck

Create an auth config

Use the dashboard to create an auth config for the Hookdeck toolkit. This allows you to connect multiple Hookdeck accounts to Composio for agents to use.

1

Select App

Navigate to Hookdeck.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Hookdeck Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1from composio import Composio
2
3# Replace these with your actual values
4hookdeck_auth_config_id = "ac_YOUR_HOOKDECK_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000" # UUID from database/app
6
7composio = Composio()
8
9def authenticate_toolkit(user_id: str, auth_config_id: str):
10 # Replace this with a method to retrieve an API key from the user.
11 # Or supply your own.
12 user_api_key = input("[!] Enter API key")
13
14 connection_request = composio.connected_accounts.initiate(
15 user_id=user_id,
16 auth_config_id=auth_config_id,
17 config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18 )
19
20 # API Key authentication is immediate - no redirect needed
21 print(f"Successfully connected Hookdeck for user {user_id}")
22 print(f"Connection status: {connection_request.status}")
23
24 return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, hookdeck_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Hookdeck toolkit’s playground

For code examples, see the Tool calling guide and Provider examples.

Tool List

Tool Name: Bulk Cancel Hookdeck Events

Description

Tool to create a bulk cancellation job for events. Use when you need to cancel multiple events matching filters.

Action Parameters

query
objectRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Bulk Retry Hookdeck Events

Description

Tool to initiate a bulk retry for a set of events. Use when you need to retry multiple failed events matching filters.

Action Parameters

query
objectRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Cancel Hookdeck Event

Description

Tool to cancel all future delivery attempts for a specific event. Use when you need to stop retries of an event before manual intervention.

Action Parameters

event_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Cancel Hookdeck Scheduled Retries

Description

Tool to cancel all future scheduled retries for an event. Use when you need to mute automatic retry attempts after repeated failures.

Action Parameters

event_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Hookdeck Bookmark

Description

Tool to create a new bookmark. Use when you want to bookmark a specific event for quick access.

Action Parameters

event_data_id
stringRequired
label
stringRequired
webhook_id
stringRequired

Action Response

alias
created_at
stringRequired
data
error
event_data_id
stringRequired
id
stringRequired
label
stringRequired
last_used_at
successful
booleanRequired
team_id
stringRequired
updated_at
stringRequired
webhook_id
stringRequired

Tool Name: Create Hookdeck Connection

Description

Tool to create a connection between a source and a destination. Use after setting up or referencing source/destination.

Action Parameters

description
destination
destination_id
name
rules
source
source_id

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Hookdeck Destination

Description

Tool to create a new Hookdeck destination. Use after setting up sources when you need to route events to endpoints.

Action Parameters

config
objectRequired
description
name
stringRequired
type

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Hookdeck Source

Description

Tool to create a new Hookdeck source. Use after setting up your project when you need to receive and route incoming webhooks.

Action Parameters

config
description
name
stringRequired
type

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Hookdeck Transformation

Description

Tool to create a new Hookdeck transformation. Use when you need to execute custom JavaScript to modify event payloads before delivery.

Action Parameters

code
stringRequired
env
name
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Hookdeck Bookmark

Description

Tool to delete a specific bookmark by its ID. Use when you need to permanently remove a bookmark after confirming it's no longer needed.

Action Parameters

bookmark_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Hookdeck Connection

Description

Tool to delete a specific connection by its ID. Use when you need to permanently remove a connection after confirming it's no longer needed.

Action Parameters

connection_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Hookdeck Destination

Description

Tool to delete a specific destination by its ID. Use when you need to permanently remove a destination after confirming it's no longer needed.

Action Parameters

destination_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Hookdeck Source

Description

Tool to delete a specific source by its ID. Use when you need to permanently remove a source after confirming it's no longer needed.

Action Parameters

source_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Hookdeck Transformation

Description

Tool to delete a specific transformation by its ID. Use when you need to permanently remove a transformation after confirming it's no longer needed.

Action Parameters

transformation_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Hookdeck Attempt

Description

Tool to retrieve details of a specific Hookdeck attempt by its ID. Use after confirming the attempt ID.

Action Parameters

attempt_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get attempts

Description

Tool to list delivery attempts for your Hookdeck account. Use when you need to retrieve attempt logs, filter by event ID, and paginate through results.

Action Parameters

dir
event_id
id
limit
next
order_by
prev

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Hookdeck Connection

Description

Tool to retrieve details of a specific Hookdeck connection. Use after confirming the connection ID.

Action Parameters

connection_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Hookdeck: Get Connections

Description

Tool to list Hookdeck connections. Use when you need to retrieve or filter your configured connections.

Action Parameters

destination_id
dir
disabled
disabled_at
full_name
id
limit
next
order_by
paused_at
prev
source_id

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Hookdeck Destination

Description

Tool to retrieve details of a specific Hookdeck destination. Use after confirming the destination ID.

Action Parameters

destination_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Hookdeck: Get Destinations

Description

Tool to list Hookdeck destinations. Use when you need to retrieve or filter your configured destinations.

Action Parameters

dir
disabled
disabled_at
id
limit
name
next
order_by
prev
type

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get events

Description

Tool to list events for your Hookdeck account. Use when you need to retrieve delivery logs, filter by status or time, and paginate through results.

Action Parameters

attempts
created_at
destination_id
dir
id
limit
next
order_by
prev
response_status
source_id
status
webhook_id

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Hookdeck Request

Description

Tool to retrieve details of a specific Hookdeck request. Use after confirming the request ID.

Action Parameters

request_id
stringRequired

Action Response

cli_events_count
created_at
stringRequired
data
error
events_count
id
stringRequired
ignored_count
integerRequired
ingested_at
original_event_data_id
rejection_cause
service_tier
stringRequired
source_id
stringRequired
successful
booleanRequired
team_id
stringRequired
updated_at
stringRequired
verified

Tool Name: Hookdeck: Get Requests

Description

Tool to list Hookdeck requests. Use when you need to retrieve requests with optional filters and pagination.

Action Parameters

body
cli_events_count
dir
events_count
headers
id
ignored_count
ingested_at
limit
next
order_by
parsed_query
path
prev
rejection_cause
source_id
status
verified

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Hookdeck Source

Description

Tool to retrieve details of a specific Hookdeck source. Use after confirming the source ID.

Action Parameters

include
source_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get sources

Description

Tool to retrieve all sources associated with your Hookdeck account. Use when you need to list or filter hook sources.

Action Parameters

dir
disabled
disabled_at
id
limit
name
next
order_by
prev
type

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Hookdeck Transformation

Description

Tool to retrieve details of a specific Hookdeck transformation. Use after confirming the transformation ID.

Action Parameters

transformation_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get transformations

Description

Tool to list Hookdeck transformations. Use when you need to retrieve or filter your Hookdeck transformations.

Action Parameters

dir
id
limit
name
next
order_by
prev

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Hookdeck Bookmarks

Description

Tool to list bookmarks. Use when you need to retrieve your Hookdeck account's bookmarks with optional filters and pagination. Use after authenticating your session.

Action Parameters

dir
event_data_id
id
label
limit
name
next
order_by
prev
webhook_id

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Hookdeck: List Issues

Description

Tool to list all issues detected in your Hookdeck account. Use when you need to retrieve and filter issues by type, status, or time.

Action Parameters

aggregation_keys
created_at
dir
dismissed_at
first_seen_at
id
issue_trigger_id
last_seen_at
limit
merged_with
next
order_by
prev
status
type

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Manually Retry Hookdeck Event

Description

Tool to manually retry a specific Hookdeck event delivery. Use when an event has failed and you need a manual retry.

Action Parameters

event_id
stringRequired

Action Response

attempts
integerRequired
cli_id
created_at
stringRequired
data
objectRequired
destination_id
stringRequired
error
error_code
event_data_id
stringRequired
id
stringRequired
last_attempt_at
next_attempt_at
request_id
stringRequired
response_status
source_id
stringRequired
status
stringRequired
successful
booleanRequired
successful_at
team_id
stringRequired
updated_at
stringRequired
webhook_id
stringRequired

Tool Name: Replay Hookdeck Event

Description

Tool to replay a specific Hookdeck event. Use when you need to manually retry a failed event delivery.

Action Parameters

event_id
stringRequired

Action Response

attempts
integerRequired
cli_id
created_at
stringRequired
data
objectRequired
destination_id
stringRequired
error
error_code
event_data_id
stringRequired
id
stringRequired
last_attempt_at
next_attempt_at
request_id
stringRequired
response_status
source_id
stringRequired
status
stringRequired
successful
booleanRequired
successful_at
team_id
stringRequired
updated_at
stringRequired
webhook_id
stringRequired

Tool Name: Resolve Hookdeck Issue

Description

Tool to resolve a Hookdeck issue. Use after confirming the underlying issue has been addressed.

Action Parameters

issue_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve Hookdeck Issue

Description

Tool to retrieve details of a specific Hookdeck issue. Use after confirming the issue ID.

Action Parameters

issue_id
stringRequired

Action Response

aggregation_keys
objectRequired
auto_resolved_at
created_at
stringRequired
data
objectRequired
dismissed_at
error
first_seen_at
stringRequired
id
stringRequired
issue_trigger_id
stringRequired
last_seen_at
stringRequired
last_updated_by
merged_with
opened_at
stringRequired
reference
objectRequired
status
stringRequired
successful
booleanRequired
team_id
stringRequired
type
stringRequired
updated_at
stringRequired

Tool Name: Send Hookdeck Source Request

Description

Tool to send HTTP requests to a Hookdeck Source URL. Use when ingesting test payloads to generate events for testing HOOKDECK_GET_EVENT.

Action Parameters

body
headers
method
stringDefaults to POST
path
query
source_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Trigger Hookdeck Bookmark

Description

Tool to trigger a stored request via its bookmark ID. Use when replaying the stored request associated with a bookmark.

Action Parameters

bookmark_id
stringRequired

Action Response

data
arrayRequired
error
successful
booleanRequired

Tool Name: Hookdeck Update Connection

Description

Tool to update an existing connection. Use when you need to modify the name, description, or rules of a connection.

Action Parameters

connection_id
stringRequired
description
name
rules

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Hookdeck Destination

Description

Tool to update an existing Hookdeck destination. Use when you need to modify a destination's settings after creation.

Action Parameters

config
description
destination_id
stringRequired
name
type

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Hookdeck Update Source

Description

Tool to update a Hookdeck source. Use when you need to modify the name, type, description, or config of an existing source.

Action Parameters

config
description
name
source_id
stringRequired
type

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Hookdeck Transformation

Description

Tool to update an existing Hookdeck transformation. Use when you need to modify a transformation's code, name, or environment variables after creation.

Action Parameters

code
env
name
transformation_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired