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

Sanity is a real-time content infrastructure with a scalable, hosted backend featuring a Graph Oriented Query Language (GROQ), asset pipelines and fast edge caches

import {type CliCommandDefinition} from '@sanity/cli'

import {type Hook} from './types'

const listHooksCommand: CliCommandDefinition = {
  name: 'list',
  group: 'hook',
  signature: '',
  helpText: '',
  description: 'List hooks for a given project',
  action: async (args, context) => {
    const {apiClient, output} = context
    const client = apiClient()

    let hooks
    try {
      hooks = await client
        .clone()
        .config({apiVersion: '2021-10-04'})
        .request<Hook[]>({uri: '/hooks'})
    } catch (err) {
      throw new Error(`Hook list retrieval failed:\n${err.message}`)
    }

    hooks.forEach((hook) => {
      output.print(`Name: ${hook.name}`)
      output.print(`Dataset: ${hook.dataset}`)
      output.print(`URL: ${hook.url}`)

      if (hook.type === 'document') {
        output.print(`HTTP method: ${hook.httpMethod}`)

        if (hook.description) {
          output.print(`Description: ${hook.description}`)
        }
      }

      output.print('')
    })
  },
}

export default listHooksCommand