Tools

A tool is one action your agent can take in Hookspot. Use these tables to see what to ask for and what a Read-only app can do.

How it works

The agent picks its tools by itself. It may show a tool’s Title when it asks you to approve a call.

Access	What the tool does	Read-only app
Read	Reads and changes nothing.	Gets it
Write	Changes something, within your role.	Refused
Link	Changes nothing and answers with a dashboard link for you to finish there.	Refused

Project tools take a project’s UID, and the agent finds it with list_projects first. Limits and errors covers the refusals a tool can answer with.

Find your projects

Tool	Title	Access
list_organizations	List organizations	Read
list_projects	List projects	Read
get_project	Read a project	Read

get_project also says what needs attention now, such as failing routes and skipped deliveries.

Debug webhooks

Tool	Title	Access
list_requests	List requests	Read
get_request	Read a request	Read
list_deliveries	List deliveries	Read
get_delivery	Read a delivery	Read
list_delivery_attempts	List a delivery’s attempts	Read
get_delivery_attempt	Read a delivery attempt	Read
retry_request	Retry a rejected request	Write
replay_request	Replay a request	Write
retry_delivery	Retry a delivery	Write
retry_skipped_deliveries	Retry skipped deliveries	Write

The retry and replay tools work as their buttons do in Inspect and retry.

Set up routes

Tool	Title	Access
list_sources	List sources	Read
get_source	Read a source	Read
create_source	Create a source	Write
update_source	Update a source	Write
delete_source	Delete a source	Write
get_custom_response_settings_link	Get a link to set a custom response	Link
send_test_request	Send a test request	Write
list_destinations	List destinations	Read
get_destination	Read a destination	Read
create_destination	Create a destination	Write
update_destination	Update a destination	Write
delete_destination	Delete a destination	Write
list_routes	List routes	Read
get_route	Read a route	Read
create_route	Create a route	Write
update_route	Update a route	Write
delete_route	Delete a route	Write
list_listeners	List CLI listeners	Read

create_route creates the destination too when no destination has that path. Ask the agent to set up a source in one message:

In my Default project, create a source named Stripe and route it to /webhooks/stripe.

The agent creates the source, the destination and the route, then gives you the source’s webhook URL.

Check health

Tool	Title	Access
get_project_stats	Read project stats	Read
get_billing	Read plan and usage	Read

Administer organizations

Tool	Title	Access
list_members	List members	Read
update_member	Change a member’s role	Write
remove_member	Remove a member	Write
get_invite_member_link	Get a link to invite a member	Link
get_resend_invitation_link	Get a link to resend an invitation	Link
revoke_invitation	Revoke an invitation	Write
create_organization	Create an organization	Write
update_organization	Update an organization	Write
create_project	Create a project	Write
update_project	Update a project	Write
delete_project	Delete a project	Write

Dashboard links

People outside Hookspot see invitations and custom responses, so you handle them in the dashboard. Ask the agent to invite a member, resend an invitation or change a source’s custom response, and it answers with a dashboard link.

Open the link, check the form and submit it there. An invitation link fills in the email and role.

Changing the plan, transferring ownership and deleting an organization stay in the dashboard too.