Sign in
hooks

Get Hook

Retrieves details of a specific hook by its ID.

get/hooks/{hook}

Request

  • Base URL: https://example.scalr.io/api/iacp/v3
  • URL: https://example.scalr.io/api/iacp/v3/hooks/{hook}
  • Auth: HTTP bearer

Path parameters

hookstring required

Query parameters

includestring[]

The comma-separated list of relationship paths.

accountsstring

The comma-separated list of fields to return in response for Account resource.

hook-readmestring

The comma-separated list of fields to return in response for HookReadme resource.

hooksstring

The comma-separated list of fields to return in response for Hook resource.

usersstring

The comma-separated list of fields to return in response for User resource.

vcs-providersstring

The comma-separated list of fields to return in response for VcsProvider resource.

vcs-revisionsstring

The comma-separated list of fields to return in response for VcsRevision resource.

The value of the fields[resource-type] parameter is a comma-separated list that refers to the name of the fields to be returned for the resource. An empty value indicates that no fields should be returned.

Response

Success.

Changes

No recorded changes to this operation across all 1 revision of this API.