Manage webhooks from the CLI

[mtilda]

Is your feature request related to a problem? Please describe.

I am looking for an easy way to work around the problem described in #8241. Currently my method is to manually modify or destroy/recreate the webhook from inside the browser. This is slow and tedious.

Describe the solution you'd like

I would like to be able to disable and re-enable webhooks, like this:

sanity hook disable
sanity hook enable

An alternative way to provide this functionality would be to add the ability to export and import a webhook config. The process of "disabling" and "re-enabling" a webhook could then look like this:

sanity hook export
sanity hook delete  # this already exists
sanity hook import

The export/import functionality would also be useful for copying webhook configurations across projects.

Additional context

In investigating this, I noticed the existing command sanity hook create actually opens a webpage in my browser. Is there a reason the CLI cannot create and update webhooks?

Are any of these features planned?

[mtilda]

I am just noticing there is an enabled/disabled status attached to the webhooks that is toggleable in-browser, so we should we should be able to control that via CLI commands.

[mtilda]

I noticed that the create command opens a browser...

sanity/packages/sanity/src/_internal/cli/commands/hook/createHookCommand.ts

Line 24 in 0ff7c7f

open(manageUrl)

While other commands like delete and list hit a REST API...

sanity/packages/sanity/src/_internal/cli/commands/hook/deleteHookCommand.ts

Line 21 in 0ff7c7f

.request({method: 'DELETE', uri: `/hooks/${hookId}`})

sanity/packages/sanity/src/_internal/cli/commands/hook/listHooksCommand.ts

Line 20 in 0ff7c7f

.request<Hook[]>({uri: '/hooks'})

Questions

• Where is the source code for the REST API?
• Can I make a PATCH request to /hooks/[hook_id]?
• Do we have any unit tests covering CLI commands? What about the REST API?

[cngonzalez]

Hi @mtilda ! I think these are valuable suggestions to add to our CLI sanity hook commands. I've forwarded them internally, but I do not have any sense of when we may be able to deliver them.

To answer some of your other questions:

1. The webhook REST API is not open-source, but we do have it documented here. Please have a look!
2. You should be able to make a PATCH request to hooks/projects/{projectId}/{id}. Please see the "Update a webhook" section in our docs and do let me know if you have any issues.
3. Yes, our CLI does have unit tests, which are available in this repo, and so do our internal services. Please let me know if you've seen errors or undesired behavior.