Documentation (2024.2 Enterprise)

# Hook Service

A hook service is an external service that can be notified when an event happens in Helix TeamHub.

- Attributes
- Operations
  - `GET /hook_services`
  - `GET /hook_services/:id`

## Attributes

### id

The identifier of the service.

- Type: `string`

### name

The name of the service.

- Type: `string`

### readme_raw

The documentation for the service, usually in markdown format.

- Type: `string`

### attributes

An array of key value pairs of the possible configurations for the service. Each entry in the array contains type and name keys. The value of type key can be one of the following: `string`, `boolean`, `password`.

- Type: `array`

### events

An array of events the service is able to handle. The possible values are `project`, `repository` and `push`.

- Type: `array`

### hookables

An array of hookables the service is able to handle. The possible values are `company`, `project` and `repository`.

- Type: `array`

## Operations

### GET /hook_services

Returns all available hook services, with optional limit and offset parameters, as a metadata-results object.

### GET /hook_services/:id

Returns the specific hook service.

#### Example Request

    curl -X GET \
      -H "Accept: application/vnd.hth.v1" \
      -H "Authorization: hth.company_key='$COMPANY_KEY',account_key='$ACCOUNT_KEY'" \
      https://helixteamhub.cloud/api/hook_services/flowdock

#### Example Response

    {
      "api_status": 200,
      "api_timestamp": "2013-07-10T11:25:04Z",
      "id": "flowdock",
      "name": "Flowdock",
      "readme_raw": "Broadcast commits to Flowdock.",
      "attributes": [
        {
          "type": "string",
          "name": "token"
        }
      ],
      "events": [
        "push"
      ],
      "hookables": [
        "repository"
      ]
    }

Your search for returned results

Your search for returned results